emscan 1.0.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,19 @@
1
+ {
2
+ "template": "https://github.com/brisvag/pyrepo-cookiecutter",
3
+ "commit": "c8cf95100485cbea6527621fb16838ca4f818b1a",
4
+ "checkout": null,
5
+ "context": {
6
+ "cookiecutter": {
7
+ "full_name": "Lorenzo Gaifas",
8
+ "email": "brisvag@gmail.com",
9
+ "github_username": "brisvag",
10
+ "project_name": "emscan",
11
+ "project_slug": "emscan",
12
+ "project_short_description": "package description.",
13
+ "pypi_username": "brisvag",
14
+ "generate_docs": false,
15
+ "_template": "https://github.com/brisvag/pyrepo-cookiecutter"
16
+ }
17
+ },
18
+ "directory": null
19
+ }
@@ -0,0 +1,15 @@
1
+ * emscan version:
2
+ * Python version:
3
+ * Operating System:
4
+
5
+ ### Description
6
+
7
+ Describe what you were trying to get done.
8
+ Tell us what happened, what went wrong, and what you expected to happen.
9
+
10
+ ### What I Did
11
+
12
+ ```
13
+ Paste the command(s) you ran and the output.
14
+ If there was a crash, please include the traceback here.
15
+ ```
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: "{{ env.TITLE }}"
3
+ labels: [bug]
4
+ ---
5
+ The {{ workflow }} workflow failed on {{ date | date("YYYY-MM-DD HH:mm") }} UTC
6
+
7
+ The most recent failing test was on {{ env.PLATFORM }} py{{ env.PYTHON }}
8
+ with commit: {{ sha }}
9
+
10
+ Full run: https://github.com/{{ repo }}/actions/runs/{{ env.RUN_ID }}
11
+
12
+ (This post will be updated if another test fails, as long as this issue remains open.)
@@ -0,0 +1,10 @@
1
+ # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2
+
3
+ version: 2
4
+ updates:
5
+ - package-ecosystem: "github-actions"
6
+ directory: "/"
7
+ schedule:
8
+ interval: "weekly"
9
+ commit-message:
10
+ prefix: "ci(dependabot):"
@@ -0,0 +1,103 @@
1
+ name: CI
2
+
3
+ concurrency:
4
+ group: ${{ github.workflow }}-${{ github.ref }}
5
+ cancel-in-progress: true
6
+
7
+ on:
8
+ push:
9
+ branches:
10
+ - main
11
+ tags:
12
+ - "v*"
13
+ pull_request:
14
+ workflow_dispatch:
15
+ schedule:
16
+ - cron: "0 0 * * 0" # every week (for --pre release tests)
17
+
18
+ jobs:
19
+ check-manifest:
20
+ runs-on: ubuntu-latest
21
+ steps:
22
+ - uses: actions/checkout@v7
23
+ - run: pipx run check-manifest
24
+
25
+ test:
26
+ name: ${{ matrix.platform }} (${{ matrix.python-version }})
27
+ runs-on: ${{ matrix.platform }}
28
+ strategy:
29
+ fail-fast: false
30
+ matrix:
31
+ python-version: ['3.11', '3.12', '3.13', '3.14']
32
+ platform: [ubuntu-latest]
33
+
34
+ steps:
35
+ - uses: actions/checkout@v7
36
+
37
+ - name: Set up Python ${{ matrix.python-version }}
38
+ uses: actions/setup-python@v7
39
+ with:
40
+ python-version: ${{ matrix.python-version }}
41
+ cache-dependency-path: "pyproject.toml"
42
+ cache: "pip"
43
+
44
+ # if running a cron job, we add the --pre flag to test against pre-releases
45
+ - name: Install dependencies
46
+ run: |
47
+ python -m pip install -U pip
48
+ python -m pip install .[test] ${{ github.event_name == 'schedule' && '--pre' || '' }}
49
+
50
+ - name: Test
51
+ run: pytest --color=yes --cov --cov-report=xml --cov-report=term-missing
52
+
53
+ # If something goes wrong, we can open an issue in the repo
54
+ - name: Report --pre Failures
55
+ if: failure() && github.event_name == 'schedule'
56
+ uses: JasonEtco/create-an-issue@v2
57
+ env:
58
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
59
+ PLATFORM: ${{ matrix.platform }}
60
+ PYTHON: ${{ matrix.python-version }}
61
+ RUN_ID: ${{ github.run_id }}
62
+ TITLE: '[test-bot] pip install --pre is failing'
63
+ with:
64
+ filename: .github/TEST_FAIL_TEMPLATE.md
65
+ update_existing: true
66
+
67
+ - name: Coverage
68
+ uses: codecov/codecov-action@v7
69
+
70
+ build-and-inspect-package:
71
+ name: Build & inspect package.
72
+ needs: test
73
+ runs-on: ubuntu-latest
74
+ steps:
75
+ - uses: actions/checkout@v7
76
+ with:
77
+ fetch-depth: 0
78
+ - uses: hynek/build-and-inspect-python-package@2abe76da66d0a6a4a227101f9348ee855797cfa5 # v3.0.1
79
+
80
+ upload-to-pypi:
81
+ name: Upload package to PyPI
82
+ needs: build-and-inspect-package
83
+ if: success() && startsWith(github.ref, 'refs/tags/') && github.event_name != 'schedule'
84
+ runs-on: ubuntu-latest
85
+ permissions:
86
+ # IMPORTANT: this permission is mandatory for trusted publishing on PyPi
87
+ # see https://docs.pypi.org/trusted-publishers/
88
+ id-token: write
89
+ # This permission allows writing releases
90
+ contents: write
91
+
92
+ steps:
93
+ - name: Download built artifact to dist/
94
+ uses: actions/download-artifact@v8
95
+ with:
96
+ name: Packages
97
+ path: dist
98
+ - name: 🚢 Publish to PyPI
99
+ uses: pypa/gh-action-pypi-publish@release/v1
100
+ - uses: softprops/action-gh-release@v3
101
+ with:
102
+ generate_release_notes: true
103
+ files: './dist/*'
@@ -0,0 +1,6 @@
1
+ user=brisvag
2
+ project=emscan
3
+ issues=false
4
+ exclude-labels=duplicate,question,invalid,wontfix,hide
5
+ add-sections={"tests":{"prefix":"**Tests & CI:**","labels":["tests"]}, "documentation":{"prefix":"**Documentation:**", "labels":["documentation"]}}
6
+ exclude-tags-regex=.*rc
@@ -0,0 +1,105 @@
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
+ env/
12
+ build/
13
+ develop-eggs/
14
+ dist/
15
+ downloads/
16
+ eggs/
17
+ .eggs/
18
+ lib/
19
+ lib64/
20
+ parts/
21
+ sdist/
22
+ var/
23
+ wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+
28
+ # PyInstaller
29
+ # Usually these files are written by a python script from a template
30
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
31
+ *.manifest
32
+ *.spec
33
+
34
+ # Installer logs
35
+ pip-log.txt
36
+ pip-delete-this-directory.txt
37
+
38
+ # Unit test / coverage reports
39
+ htmlcov/
40
+ .tox/
41
+ .coverage
42
+ .coverage.*
43
+ .cache
44
+ nosetests.xml
45
+ coverage.xml
46
+ *.cover
47
+ .hypothesis/
48
+ .pytest_cache/
49
+
50
+ # Translations
51
+ *.mo
52
+ *.pot
53
+
54
+ # Django stuff:
55
+ *.log
56
+ local_settings.py
57
+
58
+ # Flask stuff:
59
+ instance/
60
+ .webassets-cache
61
+
62
+ # Scrapy stuff:
63
+ .scrapy
64
+
65
+ # Sphinx documentation
66
+ docs/_build/
67
+
68
+ # PyBuilder
69
+ target/
70
+
71
+ # Jupyter Notebook
72
+ .ipynb_checkpoints
73
+
74
+ # pyenv
75
+ .python-version
76
+
77
+ # celery beat schedule file
78
+ celerybeat-schedule
79
+
80
+ # SageMath parsed files
81
+ *.sage.py
82
+
83
+ # dotenv
84
+ .env
85
+
86
+ # virtualenv
87
+ .venv
88
+ venv/
89
+ ENV/
90
+
91
+ # Spyder project settings
92
+ .spyderproject
93
+ .spyproject
94
+
95
+ # Rope project settings
96
+ .ropeproject
97
+
98
+ # mkdocs documentation
99
+ /site
100
+
101
+ # mypy
102
+ .mypy_cache/
103
+
104
+ # IDE settings
105
+ .vscode/
@@ -0,0 +1,23 @@
1
+ ci:
2
+ autoupdate_schedule: monthly
3
+ autofix_commit_msg: "style(pre-commit.ci): auto fixes [...]"
4
+ autoupdate_commit_msg: "ci(pre-commit.ci): autoupdate"
5
+
6
+ default_install_hook_types: [pre-commit, commit-msg]
7
+
8
+ repos:
9
+ - repo: https://github.com/charliermarsh/ruff-pre-commit
10
+ rev: v0.0.290
11
+ hooks:
12
+ - id: ruff
13
+ args: [--fix]
14
+
15
+ - repo: https://github.com/psf/black
16
+ rev: 23.9.1
17
+ hooks:
18
+ - id: black
19
+
20
+ - repo: https://github.com/abravalheri/validate-pyproject
21
+ rev: v0.14
22
+ hooks:
23
+ - id: validate-pyproject