cython-cmake 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,4 @@
1
+ node: $Format:%H$
2
+ node-date: $Format:%cI$
3
+ describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
4
+ ref-names: $Format:%D$
@@ -0,0 +1 @@
1
+ .git_archival.txt export-subst
@@ -0,0 +1,101 @@
1
+ See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
2
+ description of best practices for developing scientific packages.
3
+
4
+ [spc-dev-intro]: https://learn.scientific-python.org/development/
5
+
6
+ # Quick development
7
+
8
+ The fastest way to start with development is to use nox. If you don't have nox,
9
+ you can use `pipx run nox` to run it without installing, or `pipx install nox`.
10
+ If you don't have pipx (pip for applications), then you can install with
11
+ `pip install pipx` (the only case were installing an application with regular
12
+ pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
13
+ `brew install pipx nox`.
14
+
15
+ To use, run `nox`. This will lint and test using every installed version of
16
+ Python on your system, skipping ones that are not installed. You can also run
17
+ specific jobs:
18
+
19
+ ```console
20
+ $ nox -s lint # Lint only
21
+ $ nox -s tests # Python tests
22
+ $ nox -s docs -- --serve # Build and serve the docs
23
+ $ nox -s build # Make an SDist and wheel
24
+ ```
25
+
26
+ Nox handles everything for you, including setting up an temporary virtual
27
+ environment for each run.
28
+
29
+ # Setting up a development environment manually
30
+
31
+ You can set up a development environment by running:
32
+
33
+ ```bash
34
+ python3 -m venv .venv
35
+ source ./.venv/bin/activate
36
+ pip install -v -e .[dev]
37
+ ```
38
+
39
+ If you have the
40
+ [Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you
41
+ can instead do:
42
+
43
+ ```bash
44
+ py -m venv .venv
45
+ py -m install -v -e .[dev]
46
+ ```
47
+
48
+ # Post setup
49
+
50
+ You should prepare pre-commit, which will help you by checking that commits pass
51
+ required checks:
52
+
53
+ ```bash
54
+ pip install pre-commit # or brew install pre-commit on macOS
55
+ pre-commit install # Will install a pre-commit hook into the git repo
56
+ ```
57
+
58
+ You can also/alternatively run `pre-commit run` (changes only) or
59
+ `pre-commit run --all-files` to check even without installing the hook.
60
+
61
+ # Testing
62
+
63
+ Use pytest to run the unit checks:
64
+
65
+ ```bash
66
+ pytest
67
+ ```
68
+
69
+ # Coverage
70
+
71
+ Use pytest-cov to generate coverage reports:
72
+
73
+ ```bash
74
+ pytest --cov=cython-cmake
75
+ ```
76
+
77
+ # Building docs
78
+
79
+ You can build the docs using:
80
+
81
+ ```bash
82
+ nox -s docs
83
+ ```
84
+
85
+ You can see a preview with:
86
+
87
+ ```bash
88
+ nox -s docs -- --serve
89
+ ```
90
+
91
+ # Pre-commit
92
+
93
+ This project uses pre-commit for all style checking. While you can run it with
94
+ nox, this is such an important tool that it deserves to be installed on its own.
95
+ Install pre-commit and run:
96
+
97
+ ```bash
98
+ pre-commit run -a
99
+ ```
100
+
101
+ to check all files.
@@ -0,0 +1,11 @@
1
+ version: 2
2
+ updates:
3
+ # Maintain dependencies for GitHub Actions
4
+ - package-ecosystem: "github-actions"
5
+ directory: "/"
6
+ schedule:
7
+ interval: "weekly"
8
+ groups:
9
+ actions:
10
+ patterns:
11
+ - "*"
@@ -0,0 +1,32 @@
1
+ {
2
+ "problemMatcher": [
3
+ {
4
+ "severity": "warning",
5
+ "pattern": [
6
+ {
7
+ "regexp": "^([^:]+):(\\d+):(\\d+): ([A-DF-Z]\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
8
+ "file": 1,
9
+ "line": 2,
10
+ "column": 3,
11
+ "code": 4,
12
+ "message": 5
13
+ }
14
+ ],
15
+ "owner": "pylint-warning"
16
+ },
17
+ {
18
+ "severity": "error",
19
+ "pattern": [
20
+ {
21
+ "regexp": "^([^:]+):(\\d+):(\\d+): (E\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
22
+ "file": 1,
23
+ "line": 2,
24
+ "column": 3,
25
+ "code": 4,
26
+ "message": 5
27
+ }
28
+ ],
29
+ "owner": "pylint-error"
30
+ }
31
+ ]
32
+ }
@@ -0,0 +1,48 @@
1
+ name: CD
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ pull_request:
6
+ push:
7
+ branches:
8
+ - main
9
+ release:
10
+ types:
11
+ - published
12
+
13
+ concurrency:
14
+ group: ${{ github.workflow }}-${{ github.ref }}
15
+ cancel-in-progress: true
16
+
17
+ env:
18
+ FORCE_COLOR: 3
19
+
20
+ jobs:
21
+ dist:
22
+ name: Distribution build
23
+ runs-on: ubuntu-latest
24
+
25
+ steps:
26
+ - uses: actions/checkout@v4
27
+ with:
28
+ fetch-depth: 0
29
+
30
+ - uses: hynek/build-and-inspect-python-package@v2
31
+
32
+ publish:
33
+ needs: [dist]
34
+ name: Publish to PyPI
35
+ environment: pypi
36
+ permissions:
37
+ id-token: write
38
+ runs-on: ubuntu-latest
39
+ if: github.event_name == 'release' && github.event.action == 'published'
40
+
41
+ steps:
42
+ - uses: actions/download-artifact@v4
43
+ with:
44
+ name: Packages
45
+ path: dist
46
+
47
+ - uses: pypa/gh-action-pypi-publish@release/v1
48
+ if: github.event_name == 'release' && github.event.action == 'published'
@@ -0,0 +1,69 @@
1
+ name: CI
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ pull_request:
6
+ push:
7
+ branches:
8
+ - main
9
+
10
+ concurrency:
11
+ group: ${{ github.workflow }}-${{ github.ref }}
12
+ cancel-in-progress: true
13
+
14
+ env:
15
+ FORCE_COLOR: 3
16
+
17
+ jobs:
18
+ pre-commit:
19
+ name: Format
20
+ runs-on: ubuntu-latest
21
+ steps:
22
+ - uses: actions/checkout@v4
23
+ with:
24
+ fetch-depth: 0
25
+ - uses: actions/setup-python@v5
26
+ with:
27
+ python-version: "3.x"
28
+ - uses: pre-commit/action@v3.0.0
29
+ with:
30
+ extra_args: --hook-stage manual --all-files
31
+ - name: Run PyLint
32
+ run: |
33
+ echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
34
+ pipx run nox -s pylint
35
+
36
+ checks:
37
+ name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
38
+ runs-on: ${{ matrix.runs-on }}
39
+ needs: [pre-commit]
40
+ strategy:
41
+ fail-fast: false
42
+ matrix:
43
+ python-version: ["3.8", "3.12"]
44
+ runs-on: [ubuntu-latest, macos-latest, windows-latest]
45
+
46
+ include:
47
+ - python-version: pypy-3.10
48
+ runs-on: ubuntu-latest
49
+
50
+ steps:
51
+ - uses: actions/checkout@v4
52
+ with:
53
+ fetch-depth: 0
54
+
55
+ - uses: actions/setup-python@v5
56
+ with:
57
+ python-version: ${{ matrix.python-version }}
58
+ allow-prereleases: true
59
+
60
+ - name: Install package
61
+ run: python -m pip install .[test]
62
+
63
+ - name: Test package
64
+ run: >-
65
+ python -m pytest -ra --cov --cov-report=xml --cov-report=term
66
+ --durations=20
67
+
68
+ - name: Upload coverage report
69
+ uses: codecov/codecov-action@v3.1.4
@@ -0,0 +1,158 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
98
+ __pypackages__/
99
+
100
+ # Celery stuff
101
+ celerybeat-schedule
102
+ celerybeat.pid
103
+
104
+ # SageMath parsed files
105
+ *.sage.py
106
+
107
+ # Environments
108
+ .env
109
+ .venv
110
+ env/
111
+ venv/
112
+ ENV/
113
+ env.bak/
114
+ venv.bak/
115
+
116
+ # Spyder project settings
117
+ .spyderproject
118
+ .spyproject
119
+
120
+ # Rope project settings
121
+ .ropeproject
122
+
123
+ # mkdocs documentation
124
+ /site
125
+
126
+ # mypy
127
+ .mypy_cache/
128
+ .dmypy.json
129
+ dmypy.json
130
+
131
+ # Pyre type checker
132
+ .pyre/
133
+
134
+ # pytype static type analyzer
135
+ .pytype/
136
+
137
+ # Cython debug symbols
138
+ cython_debug/
139
+
140
+ # setuptools_scm
141
+ src/*/_version.py
142
+
143
+
144
+ # ruff
145
+ .ruff_cache/
146
+
147
+ # OS specific stuff
148
+ .DS_Store
149
+ .DS_Store?
150
+ ._*
151
+ .Spotlight-V100
152
+ .Trashes
153
+ ehthumbs.db
154
+ Thumbs.db
155
+
156
+ # Common editor files
157
+ *~
158
+ *.swp
@@ -0,0 +1,87 @@
1
+ ci:
2
+ autoupdate_commit_msg: "chore: update pre-commit hooks"
3
+ autofix_commit_msg: "style: pre-commit fixes"
4
+
5
+ repos:
6
+ - repo: https://github.com/adamchainz/blacken-docs
7
+ rev: "1.16.0"
8
+ hooks:
9
+ - id: blacken-docs
10
+ additional_dependencies: [black==23.*]
11
+
12
+ - repo: https://github.com/pre-commit/pre-commit-hooks
13
+ rev: "v4.5.0"
14
+ hooks:
15
+ - id: check-added-large-files
16
+ - id: check-case-conflict
17
+ - id: check-merge-conflict
18
+ - id: check-symlinks
19
+ - id: check-yaml
20
+ - id: debug-statements
21
+ - id: end-of-file-fixer
22
+ - id: mixed-line-ending
23
+ - id: name-tests-test
24
+ args: ["--pytest-test-first"]
25
+ - id: requirements-txt-fixer
26
+ - id: trailing-whitespace
27
+
28
+ - repo: https://github.com/pre-commit/pygrep-hooks
29
+ rev: "v1.10.0"
30
+ hooks:
31
+ - id: rst-backticks
32
+ - id: rst-directive-colons
33
+ - id: rst-inline-touching-normal
34
+
35
+ - repo: https://github.com/pre-commit/mirrors-prettier
36
+ rev: "v3.1.0"
37
+ hooks:
38
+ - id: prettier
39
+ types_or: [yaml, markdown, html, css, scss, javascript, json]
40
+ args: [--prose-wrap=always]
41
+
42
+ - repo: https://github.com/astral-sh/ruff-pre-commit
43
+ rev: "v0.1.14"
44
+ hooks:
45
+ - id: ruff
46
+ args: ["--fix", "--show-fixes"]
47
+ - id: ruff-format
48
+
49
+ - repo: https://github.com/pre-commit/mirrors-mypy
50
+ rev: "v1.8.0"
51
+ hooks:
52
+ - id: mypy
53
+ files: src|tests
54
+ args: []
55
+ additional_dependencies:
56
+ - pytest
57
+
58
+ - repo: https://github.com/codespell-project/codespell
59
+ rev: "v2.2.6"
60
+ hooks:
61
+ - id: codespell
62
+
63
+ - repo: https://github.com/shellcheck-py/shellcheck-py
64
+ rev: "v0.9.0.6"
65
+ hooks:
66
+ - id: shellcheck
67
+
68
+ - repo: local
69
+ hooks:
70
+ - id: disallow-caps
71
+ name: Disallow improper capitalization
72
+ language: pygrep
73
+ entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
74
+ exclude: .pre-commit-config.yaml
75
+
76
+ - repo: https://github.com/abravalheri/validate-pyproject
77
+ rev: "v0.16"
78
+ hooks:
79
+ - id: validate-pyproject
80
+ additional_dependencies: ["validate-pyproject-schema-store[all]"]
81
+
82
+ - repo: https://github.com/python-jsonschema/check-jsonschema
83
+ rev: "0.27.3"
84
+ hooks:
85
+ - id: check-dependabot
86
+ - id: check-github-workflows
87
+ - id: check-readthedocs
@@ -0,0 +1,18 @@
1
+ # Read the Docs configuration file
2
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
+
4
+ version: 2
5
+
6
+ build:
7
+ os: ubuntu-22.04
8
+ tools:
9
+ python: "3.11"
10
+ sphinx:
11
+ configuration: docs/conf.py
12
+
13
+ python:
14
+ install:
15
+ - method: pip
16
+ path: .
17
+ extra_requirements:
18
+ - docs