mirror of
https://github.com/sb745/NyaaV3.git
synced 2025-03-12 22:06:55 +02:00
Compare commits
2 commits
6102316052
...
438ce1cd6f
Author | SHA1 | Date | |
---|---|---|---|
438ce1cd6f | |||
a9f18fafd4 |
1 changed files with 5 additions and 5 deletions
|
@ -1,4 +1,4 @@
|
||||||
# NyaaV3 [](https://www.python.org) 
|
# NyaaV3 [](https://www.python.org) 
|
||||||
|
|
||||||
## 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,7 +129,7 @@ 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 it’s a torrent tracker, I can’t 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.
|
||||||
|
|
Loading…
Add table
Reference in a new issue