Skip to content

Commit

Permalink
chore: repository structure update
Browse files Browse the repository at this point in the history
  • Loading branch information
LightDestory committed Apr 16, 2023
1 parent 5ba39ad commit 8892e61
Show file tree
Hide file tree
Showing 10 changed files with 250 additions and 26 deletions.
49 changes: 49 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing Guidelines

A big welcome and thank you for considering contributing to open source projects! It’s people like you that make it a reality for users in our community.

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

## Quicklinks

- [Contributing Guidelines](#contributing-guidelines)
- [Quicklinks](#quicklinks)
- [Getting Started](#getting-started)
- [Issues](#issues)
- [Pull Requests](#pull-requests)

## Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

- Search for existing Issues and PRs before creating your own.
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
- If you've never contributed before, see [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) for resources and tips on how to get started.

### Issues

Issues should be used to report problems, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.

### Pull Requests

PRs are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the ["Forking" workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow), known also as "Fork & Pull workflow".

1. Fork the repository to your own Github account
2. Clone the project to your machine
3. Create a branch locally with a succinct but descriptive name
4. Commit changes to the branch
5. Following any formatting and testing guidelines specific to this repo
6. Push changes to your fork
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ko_fi: lightdestory
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Report an issue
about: Create a bug report to fix an existing issue.
title: ''
labels: 'bug'
assignees: ''

---

**Thank you in advance for the feedback!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help to respond as quickly as possible. To avoid duplicates, please search existing Issues before submitting one here.

### Description

> Provide a clear and concise description of the issue, including what you expected to happen.
### Reproduction

> Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced consistently or if it is intermittent.
>
> Where applicable, please include:
>
> - Code sample to reproduce the issue
> - Log files (redact/remove sensitive information)
> - Application settings (redact/remove sensitive information)
> - Screenshots
### Environment

> If the context needs them, please provide the following:
- **Type and Version of your Operation System:**
- **Version of the affected software:**
- **Other relevant information such as module, plugin and so on:**
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature request
about: Suggest new functionality for this project.
title: ''
labels: 'feature request'
assignees: ''

---

**Thank you in advance for the feedback!** Please read through the template below and answer all relevant questions. A clear comunication is greatly appreciated and will help to respond as quickly as possible. To avoid duplicates, please search existing Issues before submitting one here.

### Describe the problem/feature you'd like to have solved/implemented

> A clear and concise description of what the problem/feature is.
### Describe the ideal solution

> If you have the proper knownledge, provide a developer point of view description of what you want to happen.
>
> Delete this section if not needed
### Additional context

> Add any other context or screenshots about the feature request here.
>
> Delete this section if not needed.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Please see the __contributing guidelines__ for how to create and submit a PR.

### Description

> Describe the purpose of this PR along with any background information and the impacts of the proposed change such as breaking changes and alternatives considered.
>
> If a graphical change is proposed, please provide screenshots.
### References

> Include any links supporting this change such as a:
>
> - GitHub Issue/PR number addressed or fixed
> - StackOverflow post
> - Related pull requests/issues from other repos
>
> If there are no references, simply delete this section.
### Checklist

- [ ] If necessary, I have added documentation for new/changed functionality in this PR
- [ ] If present, all active GitHub checks for tests, formatting, and security are passing
- [ ] The correct base branch is being used, if the target is not `master`
File renamed without changes
Binary file added .github/assets/images/support.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions LICENSE.md → LICENSE
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Expand Down Expand Up @@ -646,14 +645,14 @@ the "copyright" line and a pointer to where the full notice is found.
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
along with this program. If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

{project} Copyright (C) {year} {fullname}
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
Expand All @@ -665,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
<https://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
<https://www.gnu.org/licenses/why-not-lgpl.html>.
131 changes: 112 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,52 @@
# NIF Dumper
<a name="readme-top"></a>

<p align="center"><img src="https://raw.githubusercontent.com/LightDestory/NIF-Dumper/master/.github/assets/preview.gif" alt="Preview" width=600px/></p>
<!-- Presentation Block -->
<br />

<div align="center">

<a href="https://github.com/LightDestory/RepositoryTemplate">
<img src=".github/assets/images/presentation_image.gif" alt="Preview" width="90%">
</a>

<h2 align="center">NIF Dumper</h2>

<p align="center">
A simple Python CLI tool to search and download NIF (Naruto Italian Forum) releases
</p>

<br />
<br />

</div>

<!-- ToC -->

<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#book-about-the-project">📖 About The Project</a>
</li>
<li>
<a href="#gear-getting-started">⚙️ Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#notes">Notes</a></li>
</ul>
</li>
<li><a href="#dizzy-contributing">💫 Contributing</a></li>
<li><a href="#handshake-support">🤝 Support</a></li>
<li><a href="#warning-license">⚠️ License</a></li>
<li><a href="#hammer_and_wrench-built-with">🛠️ Built With</a></li>
</ol>
</details>

<!-- About Block -->

## :book: About The Project

A simple Python CLI tool to search and download NIF (Naruto Italian Forum) releases.

Expand All @@ -10,37 +56,84 @@ If you like NIF releases, support the team!

__This project is in no way affiliated with, supported or offered by NIF Team__

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- Setup Block -->

## Install and Usage
## :gear: Getting Started

### Prerequisites

__Make sure to have Python 3.7+ and aria2 installed on your system.__

You can install this tool as a Python Module using pip
or using the script directly. The dumper provide a wizard that will help you download the releases.
<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Installation
You can install this tool as a Python Module using `pip`
or executing the script directly.

- If you want to install the tool as a Python Module:
- Install the module using pip: `pip install nif-dumper`
- You can run the tool using: `nif-dumper`
- Install the module using pip: `pip install nif-dumper`
- You can run the tool using: `nif-dumper`
- If you want to use the script directly:
- Clone the repository anywhere on your pc:

`git clone https://github.com/LightDestory/NIF-Dumper`
- Clone the repository anywhere on your pc:

`git clone https://github.com/LightDestory/NIF-Dumper`

- Install the requirements using `pip` (create a `venv` if you want):

`pip install .`

- Run the dumper:

`python ./src/nif_dumper/dumper.py`

<p align="right">(<a href="#readme-top">back to top</a>)</p>

- Install the requirements using pip:
### Usage

`pip install .`
The dumper provides a wizard that will help you to download the releases.

- Run the dumper:
<p align="right">(<a href="#readme-top">back to top</a>)</p>

`python ./src/nif_dumper/dumper.py`
<!-- Contribute Block -->

## Support
## :dizzy: Contributing

If you are interested in contributing, please refer to [Contributing Guidelines](.github/CONTRIBUTING.md) for more information and take a look at open issues. Ask any questions you may have and you will be provided guidance on how to get started.

Thank you for considering contributing.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- Support Block -->

## :handshake: Support

If you find value in my work, please consider making a donation to help me create, and improve my projects.

Your donation will go a long way in helping me continue to create free software that can benefit people around the world.

<p align="center">
<a href="https://coindrop.to/lightdestory" target="__blank"><img alt="Coindrop" title="Support me with a donation!"
src="https://img.shields.io/badge/-Support me with coindrop.to-yellowgreen?style=for-the-badge&logo=paypal&logoColor=white" /></a>
<a href='https://ko-fi.com/M4M6KC01A' target='_blank'><img src='.github/assets/images/support.png' alt='Buy Me a Hot Chocolate at ko-fi.com' width="45%" /></a>
</p>

## ⚠️ License
<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- License Block -->

## :warning: License

The content of this repository is distributed under the GNU GPL-3.0 License. See `LICENSE` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- Built With Block -->

## :hammer_and_wrench: Built With

- [Python](https://www.python.org/)
- [beautifulsoup4](https://www.crummy.com/software/BeautifulSoup/)
- [InquirerPy](https://inquirerpy.readthedocs.io/en/latest/)

This collection is under GNU GPL-3.0 License.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
2 changes: 1 addition & 1 deletion src/nif_dumper/dumper.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from requests import Response
from termcolor import colored

VERSION = "1.0.2"
VERSION = "1.0.3"
NIF_SCRAPE_TEMPLATE: str = "https://nifteam.info/Multimedia/?Anime=%key%"
NIF_DL_TEMPLATE: str = "https://download.nifteam.info/Download/Anime/%episode%"
NIF_HOME_KEY: str = "Homepage"
Expand Down

0 comments on commit 8892e61

Please sign in to comment.