diff --git a/.github/workflows/multi-platforms.yml b/.github/workflows/multi-platforms.yml index cdb5b3c..6796ba0 100644 --- a/.github/workflows/multi-platforms.yml +++ b/.github/workflows/multi-platforms.yml @@ -7,7 +7,7 @@ jobs: runs-on: ${{ matrix.os }} strategy: matrix: - os: ["ubuntu-latest", "windows-latest", "macos-latest"] + os: ["ubuntu-latest", "windows-latest"] version: [3.8, 3.9] steps: - uses: actions/checkout@v2 diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml index 5472a9c..58ca336 100644 --- a/.github/workflows/python-app.yml +++ b/.github/workflows/python-app.yml @@ -41,6 +41,6 @@ jobs: uses: codecov/codecov-action@v1.5.2 with: # Repository upload token - get it from codecov.io. Required only for private repositories - token: e8eb11dc-6d05-4ea8-b835-43456e2aed29 + token: ${{ secrets.CODECOV_TOKEN }} # Comma-separated list of files to upload fail_ci_if_error: true diff --git a/.github/workflows/pythonapp.yml b/.github/workflows/pythonapp.yml index 4ae28e3..95634bd 100644 --- a/.github/workflows/pythonapp.yml +++ b/.github/workflows/pythonapp.yml @@ -37,6 +37,6 @@ jobs: # uses: codecov/codecov-action@v1.5.2 # with: # # Repository upload token - get it from codecov.io. Required only for private repositories - # token: # optional + # token: ${{ secrets.CODECOV_TOKEN }} # # Comma-separated list of files to upload # fail_ci_if_error: true diff --git a/.gitignore b/.gitignore index e9e1e9b..d4a6f0e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,42 +1,163 @@ -# Temporary and binary files -*~ +# Byte-compiled / optimized / DLL files +__pycache__/ *.py[cod] +*$py.class + +# C extensions *.so -*.cfg -!.isort.cfg -!setup.cfg -*.orig -*.log -*.pot -__pycache__/* -.cache/* -.*.swp -*/.ipynb_checkpoints/* -.DS_Store -# Project files -.ropeproject -.project -.pydevproject -.settings -.idea -.vscode -tags - -# Package files -*.egg -*.eggs/ +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ .installed.cfg -*.egg-info +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt -# Unittest and coverage -htmlcov/* +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ .coverage .coverage.* -.tox -junit*.xml +.cache +nosetests.xml coverage.xml +*.cover +*.py,cover +.hypothesis/ .pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ # Build and docs folder/files build/* diff --git a/.readthedocs.yml b/.readthedocs.yml index d012fe8..019ba61 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,27 +1,32 @@ +# .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py - -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml - -# Optionally build your docs in additional formats such as PDF -formats: - - pdf - +# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: - python: "3.11" + python: "3.12" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - requirements: docs/requirements.txt - - { path: ., method: pip }