Skip to content

Commit

Permalink
Merge pull request #3 from Animenosekai/next
Browse files Browse the repository at this point in the history
`next`
  • Loading branch information
Animenosekai authored Aug 11, 2023
2 parents 8d66662 + 0bc1211 commit dc20a77
Show file tree
Hide file tree
Showing 92 changed files with 5,916 additions and 1,347 deletions.
Binary file removed .DS_Store
Binary file not shown.
30 changes: 0 additions & 30 deletions .github/workflows/pypi.yml

This file was deleted.

5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,7 @@ dmypy.json
mongo_secret.py

# MongoDB tests
test/*
test/*

# Config
.http.nasse.config
1 change: 1 addition & 0 deletions .nasse/config/http
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"language":"eng","timeout":10.0,"allow_redirects":true,"proxies":{},"verify":true,"cert":[],"history_limit":10,"endpoints_update":10}
11 changes: 11 additions & 0 deletions .vscode/ltex.dictionary.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
PyPI
CodeQL
UserSent
Nasse
camelCase
Werkzeug
Animenosekai
CherryPieWithPoison
delfick
Gunicorn
dataclasses
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"[python]": {
"editor.defaultFormatter": "ms-python.autopep8"
},
"python.formatting.provider": "none"
}
24 changes: 21 additions & 3 deletions NEXT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,17 @@ status: BETA

# Next

> Provides informations about the next coming version
> Provides information about the next coming version
This version provides general improvements over the whole project, brining more stability and ease of use.

> **Warning**
> This is a breaking update !
The endpoints modelling objects are now slightly different. Most of them support method variation, which lets the app developer change the endpoint definition for different methods.

Also, this comes with several changes in how the models attributes and parameters are managed. Please look at the new models' definition before updating.

## New

- Docs Localization: You can now choose a language for the automatic documentation generation (please contribute to add your language!)
Expand All @@ -19,23 +26,34 @@ This version provides general improvements over the whole project, brining more
- Switch to a local variables based system (more stable)
- Using [`rich`](https://github.com/Textualize/rich) to output things to the console, which improves the UI a lot
- Adding a CLI to easily run Nasse apps
- Adding a TUI to test endpoints, similar to Postman
- Starting to add debug endpoints, when the server is running in `DEBUG` mode
- Add a way of giving a sub category to endpoints
- Improving endpoint definitions, letting the developer the ability to document them with a Python-native approach (a big part of it can be directly extracted from the function definition)
- Introducing a new server backend based system to run the server, which allows the user to actually specify if they want to use *Gunicorn* or any other WSGI compatible server backend. (this fixes a pretty big bug where people on Windows couldn't really run their server)

## Fixes

- Fixing a problem with CORS headers
- Fixing a problem with request verifications
- Fixing an issue with `UserSent` validation
- Fixing an issue with the Windows operating system

## Updates

- Using *dataclasses* for endpoint models
- Using `pyproject.toml`
- Using correct versioning
- Using [poetry](https://python-poetry.org)
- Only log exceptions when wanted
- Better compatibility
- Other little improvements
- Improved code quality
- Improved in-code docs
- Using the `perf_counter` clock instead of the `process_time` one for better results
- Type-hinting code more
- Making a fully custom NasseJSONEncoder with more flexibility (example: encoding default types)
- The `Args` utility is more complete
- Making a fully custom `NasseJSONEncoder` with more flexibility (example: encoding default types)
- Other little improvements

Everything is detailed in the [`README.md`](./README.md) file

Expand Down
Loading

0 comments on commit dc20a77

Please sign in to comment.