Skip to content

Commit

Permalink
chore: update to V1 (#96)
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau authored Jan 18, 2024
2 parents 918abab + 6337ae9 commit 0658b85
Show file tree
Hide file tree
Showing 238 changed files with 91,985 additions and 26,727 deletions.
73 changes: 73 additions & 0 deletions .github/unit.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Unit tests

on:
workflow_dispatch:
push:
branches:
- main
pull_request:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- uses: pre-commit/[email protected]

docs:
needs: [lint] #, mypy]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install nox
run: pip install nox
- name: build static docs
run: nox -s docs

build:
needs: [lint] #, mypy]
strategy:
fail-fast: true
matrix:
os: [ubuntu-latest]
python-version: ["3.8", "3.9", "3.10", "3.11"]
include:
- os: macos-latest # macos test
python-version: "3.11"
- os: windows-latest # windows test
python-version: "3.11"
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install nox
run: pip install nox
- name: test with pytest
run: nox -s test

coverage:
needs: [build]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install deps
run: pip install nox
- name: test with pytest
run: nox -s test
- name: codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
verbose: true
104 changes: 88 additions & 16 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Created by .ignore support plugin (hsz.mobi)
### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand All @@ -10,18 +8,19 @@ __pycache__/

# Distribution / packaging
.Python
/build
.develop-eggs/
/dist/
.downloads/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
.sdist/
.var/
.wheels/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
Expand All @@ -40,20 +39,85 @@ pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.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
.python-version
# 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
Expand All @@ -76,13 +140,21 @@ venv.bak/

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

.idea/
# gee_tools.iml
# Pyre type checker
.pyre/

files/
# pytype static type analyzer
.pytype/

# any checkpoint
**/.ipynb_checkpoints
# Cython debug symbols
cython_debug/

**.patch
# 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/
53 changes: 53 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
default_install_hook_types: [pre-commit, commit-msg]

repos:
- repo: "https://github.com/psf/black"
rev: "22.3.0"
hooks:
- id: black
stages: [commit]

# - repo: "https://github.com/commitizen-tools/commitizen"
# rev: "v2.18.0"
# hooks:
# - id: commitizen
# stages: [commit-msg]

# - repo: "https://github.com/kynan/nbstripout"
# rev: "0.5.0"
# hooks:
# - id: nbstripout
# stages: [commit]

- repo: "https://github.com/pre-commit/mirrors-prettier"
rev: "v2.7.1"
hooks:
- id: prettier
stages: [commit]
exclude: tests\/test_.+\.

- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: "v0.0.215"
hooks:
- id: ruff
stages: [commit]

# - repo: https://github.com/PyCQA/doc8
# rev: "v1.1.1"
# hooks:
# - id: doc8
# stages: [commit]

- repo: https://github.com/FHPythonUtils/LicenseCheck
rev: "2023.1.1"
hooks:
- id: licensecheck
stages: [commit]

- repo: https://github.com/codespell-project/codespell
rev: v2.2.4
hooks:
- id: codespell
stages: [commit]
additional_dependencies:
- tomli
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"

sphinx:
configuration: docs/conf.py

python:
install:
- method: pip
path: .
extra_requirements:
- doc
52 changes: 52 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Thanks goes to these wonderful people (`emoji key <https://allcontributors.org/docs/en/emoji-key>`_):

.. raw:: html

<table class="table table-bordered">
<tr>
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<td align="center">
<a href="https://github.com/fitoprincipe">
<img src="https://github.com/fitoprincipe.png" width="70px;" alt="12rambau"/><br />
<sub><b>Rodrigo E. Principe </b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/12rambau">
<img src="https://github.com/12rambau.png" width="70px;" alt="12rambau"/><br />
<sub><b>Pierrick Rambaud</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/MarcCoru">
<img src="https://github.com/MarcCoru.png" width="70px;" alt="12rambau"/><br />
<sub><b>Marc Rußwurm</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/hubert-crea">
<img src="https://github.com/hubert-crea.png" width="70px;" alt="12rambau"/><br />
<sub><b>hubert-crea</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/samsammurphy">
<img src="https://github.com/samsammurphy.png" width="70px;" alt="12rambau"/><br />
<sub><b>Sam Murphy</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/lumbric">
<img src="https://github.com/lumbric.png" width="70px;" alt="12rambau"/><br />
<sub><b>lumbric</b></sub>
</a>
</td>
<!-- ALL-CONTRIBUTORS-LIST:END -->
</tr>
</table>

This project follows the `all-contributors <https://allcontributors.org>`_ specification.

Contributions of any kind are welcome!
Loading

0 comments on commit 0658b85

Please sign in to comment.