Compare commits

...

2 commits

Author SHA1 Message Date
438ce1cd6f
Update README.md
Some checks failed
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
2025-03-03 00:51:51 +02:00
a9f18fafd4
Update README.md 2025-03-03 00:50:55 +02:00

View file

@ -1,4 +1,4 @@
# NyaaV3 [![python](https://img.shields.io/badge/Python-3.13.2-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org) ![Maintenance](https://img.shields.io/maintenance/yes/2025) # NyaaV3 [![python](https://img.shields.io/badge/Python-3.13-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org) ![Maintenance](https://img.shields.io/maintenance/yes/2025)
## Setting up for development ## Setting up for development
This project uses Python 3.13. The codebase has been updated from the original Python 3.7 version to use modern Python features and updated dependencies. This project uses Python 3.13. The codebase has been updated from the original Python 3.7 version to use modern Python features and updated dependencies.
@ -12,12 +12,12 @@ Running Nyaa on Windows may be possible, but it's currently unsupported.
- Replaced deprecated Flask-Script, orderedset and `flask.Markup` with Flask CLI, orderly-set and markupsafe - Replaced deprecated Flask-Script, orderedset and `flask.Markup` with Flask CLI, orderly-set and markupsafe
- Implemented mail error handling - Implemented mail error handling
### Code Quality: ### Code Quality
- Before we get any deeper, remember to follow PEP8 style guidelines and run `python dev.py lint` before committing to see a list of warnings/problems. - Before we get any deeper, remember to follow PEP8 style guidelines and run `python dev.py lint` before committing to see a list of warnings/problems.
- You may also use `python dev.py fix && python dev.py isort` to automatically fix some of the issues reported by the previous command. - You may also use `python dev.py fix && python dev.py isort` to automatically fix some of the issues reported by the previous command.
- Other than PEP8, try to keep your code clean and easy to understand, as well. It's only polite! - Other than PEP8, try to keep your code clean and easy to understand, as well. It's only polite!
### Running Tests ### Running tests
The `tests` folder contains tests for the the `nyaa` module and the webserver. To run the tests: The `tests` folder contains tests for the the `nyaa` module and the webserver. To run the tests:
- Make sure that you are in the Python virtual environment. - Make sure that you are in the Python virtual environment.
- Run `python dev.py test` while in the repository directory. - Run `python dev.py test` while in the repository directory.
@ -129,10 +129,10 @@ This project is licensed under the GNU General Public License v3.0 (GPL-3.0). Se
## Disclaimer ## Disclaimer
> [!CAUTION] > [!CAUTION]
> **This project was created as a learning experience, and while its a torrent tracker, I cant control how people choose to use it.** > **This project was created as a learning experience, and while it's a torrent tracker, I can't control how people choose to use it.**
By using this software, you're agreeing to a few things: By using this software, you're agreeing to a few things:
- I'm not responsible for any legal issues that might come up from using this tracker, especially if it's used to share copyrighted content without permission. - I'm not responsible for any legal issues that might come up from using this tracker, especially if it's used to share copyrighted content without permission.
- It's your responsibility to make sure you're following the laws in your area when using this software. - It's your responsibility to make sure you're following the laws in your area when using this software.
**Please use this project wisely and stay on the right side of the law.** Happy coding! **Please use this project wisely and stay on the right side of the law.** Happy coding!