grat 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,54 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ fail-fast: false
13
+ matrix:
14
+ python-version: ["3.10", "3.11", "3.12", "3.13"]
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+
18
+ - name: Install uv
19
+ uses: astral-sh/setup-uv@v5
20
+ with:
21
+ python-version: ${{ matrix.python-version }}
22
+
23
+ - name: Install dependencies
24
+ run: uv sync --all-groups
25
+
26
+ - name: Lint
27
+ run: uv run ruff check .
28
+
29
+ - name: Format check
30
+ run: uv run ruff format --check .
31
+
32
+ - name: Type-check
33
+ run: uv run mypy
34
+
35
+ - name: Test
36
+ run: uv run pytest
37
+
38
+ build:
39
+ runs-on: ubuntu-latest
40
+ needs: test
41
+ steps:
42
+ - uses: actions/checkout@v4
43
+
44
+ - name: Install uv
45
+ uses: astral-sh/setup-uv@v5
46
+
47
+ - name: Build package
48
+ run: uv build
49
+
50
+ - name: Upload build artifacts
51
+ uses: actions/upload-artifact@v4
52
+ with:
53
+ name: dist
54
+ path: dist/
@@ -0,0 +1,39 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ jobs:
8
+ build:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v4
12
+
13
+ - name: Install uv
14
+ uses: astral-sh/setup-uv@v5
15
+
16
+ - name: Build package
17
+ run: uv build
18
+
19
+ - name: Upload build artifacts
20
+ uses: actions/upload-artifact@v4
21
+ with:
22
+ name: dist
23
+ path: dist/
24
+
25
+ publish:
26
+ runs-on: ubuntu-latest
27
+ needs: build
28
+ environment: pypi
29
+ permissions:
30
+ id-token: write # required for PyPI trusted publishing (OIDC)
31
+ steps:
32
+ - name: Download build artifacts
33
+ uses: actions/download-artifact@v4
34
+ with:
35
+ name: dist
36
+ path: dist/
37
+
38
+ - name: Publish to PyPI
39
+ uses: pypa/gh-action-pypi-publish@release/v1
grat-0.1.0/.gitignore ADDED
@@ -0,0 +1,170 @@
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
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110
+ .pdm.toml
111
+ .pdm-python
112
+ .pdm-build/
113
+
114
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115
+ __pypackages__/
116
+
117
+ # Celery stuff
118
+ celerybeat-schedule
119
+ celerybeat.pid
120
+
121
+ # SageMath parsed files
122
+ *.sage.py
123
+
124
+ # Environments
125
+ .env
126
+ .venv
127
+ env/
128
+ venv/
129
+ ENV/
130
+ env.bak/
131
+ venv.bak/
132
+
133
+ # Spyder project settings
134
+ .spyderproject
135
+ .spyproject
136
+
137
+ # Rope project settings
138
+ .ropeproject
139
+
140
+ # mkdocs documentation
141
+ /site
142
+
143
+ # mypy
144
+ .mypy_cache/
145
+ .dmypy.json
146
+ dmypy.json
147
+
148
+ # Pyre type checker
149
+ .pyre/
150
+
151
+ # pytype static type analyzer
152
+ .pytype/
153
+
154
+ # Cython debug symbols
155
+ cython_debug/
156
+
157
+ # vs code settings
158
+ .vscode/
159
+
160
+
161
+ # uv
162
+ uv.lock.bak
163
+
164
+ # Ruff
165
+ .ruff_cache/
166
+
167
+ # Editors / OS
168
+ .idea/
169
+ .DS_Store
170
+ Thumbs.db
@@ -0,0 +1,16 @@
1
+ repos:
2
+ - repo: https://github.com/astral-sh/ruff-pre-commit
3
+ rev: v0.16.5
4
+ hooks:
5
+ - id: ruff
6
+ args: [--fix]
7
+ - id: ruff-format
8
+
9
+ - repo: https://github.com/pre-commit/pre-commit-hooks
10
+ rev: v5.0.0
11
+ hooks:
12
+ - id: trailing-whitespace
13
+ - id: end-of-file-fixer
14
+ - id: check-toml
15
+ - id: check-yaml
16
+ - id: check-merge-conflict
@@ -0,0 +1 @@
1
+ 3.13
@@ -0,0 +1,12 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Added
11
+
12
+ - Initial project scaffolding.
@@ -0,0 +1,31 @@
1
+ # Contributing
2
+
3
+ ## Setup
4
+
5
+ ```bash
6
+ uv sync
7
+ ```
8
+
9
+ This installs runtime and dev dependencies into a local `.venv`.
10
+
11
+ ## Workflow
12
+
13
+ 1. Create a branch for your change.
14
+ 2. Make the change, with tests in `tests/`.
15
+ 3. Run the checks before opening a PR:
16
+
17
+ ```bash
18
+ uv run pytest
19
+ uv run ruff check .
20
+ uv run ruff format --check .
21
+ uv run mypy
22
+ ```
23
+
24
+ 4. Open a pull request describing the change and, if user-facing, add an entry
25
+ to [CHANGELOG.md](CHANGELOG.md) under `[Unreleased]`.
26
+
27
+ ## Code style
28
+
29
+ - Formatting and linting are enforced by [ruff](https://docs.astral.sh/ruff/).
30
+ - Public functions and classes should have type annotations (checked by mypy
31
+ in strict mode).
grat-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Earth Genome
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
grat-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,61 @@
1
+ Metadata-Version: 2.5
2
+ Name: grat
3
+ Version: 0.1.0
4
+ Summary: Add your description here
5
+ Project-URL: Homepage, https://github.com/blueraster/earth-genome-grat
6
+ Project-URL: Repository, https://github.com/blueraster/earth-genome-grat
7
+ Project-URL: Issues, https://github.com/blueraster/earth-genome-grat/issues
8
+ Project-URL: Changelog, https://github.com/blueraster/earth-genome-grat/blob/main/CHANGELOG.md
9
+ Author-email: Andy Bell <abell@blueraster.com>
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Typing :: Typed
20
+ Requires-Python: >=3.10
21
+ Description-Content-Type: text/markdown
22
+
23
+ # grat
24
+
25
+ [![CI](https://github.com/<owner>/grat/actions/workflows/ci.yml/badge.svg)](https://github.com/<owner>/grat/actions/workflows/ci.yml)
26
+ [![PyPI](https://img.shields.io/pypi/v/grat.svg)](https://pypi.org/project/grat/)
27
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
28
+
29
+ One-line description of what `grat` does.
30
+
31
+ ## Installation
32
+
33
+ ```bash
34
+ pip install grat
35
+ ```
36
+
37
+ ## Usage
38
+
39
+ ```python
40
+ import grat
41
+ ```
42
+
43
+ ## Development
44
+
45
+ This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
46
+
47
+ ```bash
48
+ uv sync # install dependencies (incl. dev group) into .venv
49
+ uv run pytest # run tests
50
+ uv run ruff check . # lint
51
+ uv run ruff format . # format
52
+ uv run mypy # type-check
53
+ ```
54
+
55
+ ## Contributing
56
+
57
+ See [CONTRIBUTING.md](CONTRIBUTING.md).
58
+
59
+ ## License
60
+
61
+ MIT — see [LICENSE](LICENSE).
grat-0.1.0/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # grat
2
+
3
+ [![CI](https://github.com/<owner>/grat/actions/workflows/ci.yml/badge.svg)](https://github.com/<owner>/grat/actions/workflows/ci.yml)
4
+ [![PyPI](https://img.shields.io/pypi/v/grat.svg)](https://pypi.org/project/grat/)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
6
+
7
+ One-line description of what `grat` does.
8
+
9
+ ## Installation
10
+
11
+ ```bash
12
+ pip install grat
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ```python
18
+ import grat
19
+ ```
20
+
21
+ ## Development
22
+
23
+ This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
24
+
25
+ ```bash
26
+ uv sync # install dependencies (incl. dev group) into .venv
27
+ uv run pytest # run tests
28
+ uv run ruff check . # lint
29
+ uv run ruff format . # format
30
+ uv run mypy # type-check
31
+ ```
32
+
33
+ ## Contributing
34
+
35
+ See [CONTRIBUTING.md](CONTRIBUTING.md).
36
+
37
+ ## License
38
+
39
+ MIT — see [LICENSE](LICENSE).
@@ -0,0 +1,58 @@
1
+ [project]
2
+ name = "grat"
3
+ version = "0.1.0"
4
+ description = "Add your description here"
5
+ readme = "README.md"
6
+ license = "MIT"
7
+ license-files = ["LICENSE"]
8
+ authors = [
9
+ { name = "Andy Bell", email = "abell@blueraster.com" }
10
+ ]
11
+ requires-python = ">=3.10"
12
+ dependencies = []
13
+ classifiers = [
14
+ "Development Status :: 3 - Alpha",
15
+ "Intended Audience :: Developers",
16
+ "Programming Language :: Python :: 3",
17
+ "Programming Language :: Python :: 3.10",
18
+ "Programming Language :: Python :: 3.11",
19
+ "Programming Language :: Python :: 3.12",
20
+ "Programming Language :: Python :: 3.13",
21
+ "Typing :: Typed",
22
+ ]
23
+
24
+ [project.urls]
25
+ Homepage = "https://github.com/blueraster/earth-genome-grat"
26
+ Repository = "https://github.com/blueraster/earth-genome-grat"
27
+ Issues = "https://github.com/blueraster/earth-genome-grat/issues"
28
+ Changelog = "https://github.com/blueraster/earth-genome-grat/blob/main/CHANGELOG.md"
29
+
30
+ [build-system]
31
+ requires = ["hatchling"]
32
+ build-backend = "hatchling.build"
33
+
34
+ [dependency-groups]
35
+ dev = [
36
+ "mypy>=2.3.1",
37
+ "pre-commit>=4.6.2",
38
+ "pytest>=9.1.1",
39
+ "ruff>=0.16.5",
40
+ ]
41
+
42
+ [tool.ruff]
43
+ line-length = 100
44
+ target-version = "py310"
45
+
46
+ [tool.ruff.lint]
47
+ select = ["E", "F", "I", "UP", "B", "SIM"]
48
+
49
+ [tool.mypy]
50
+ python_version = "3.10"
51
+ strict = true
52
+ files = ["src"]
53
+
54
+ [tool.pytest.ini_options]
55
+ testpaths = ["tests"]
56
+
57
+ [tool.hatch.build.targets.wheel]
58
+ packages = ["src/grat"]
@@ -0,0 +1,2 @@
1
+ def hello() -> str:
2
+ return "Hello from grat!"
File without changes
File without changes
@@ -0,0 +1,5 @@
1
+ import grat
2
+
3
+
4
+ def test_import() -> None:
5
+ assert grat.hello() == "Hello from grat!"