Skip to content

Commit adee717

Browse files
alukachalukach
committed
Add initial version
0 parents  commit adee717

File tree

14 files changed

+1579
-0
lines changed

14 files changed

+1579
-0
lines changed

‎.github/workflows/lint.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Lint
2+
3+
on:
4+
push:
5+
paths:
6+
- "**/*.py"
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Set up Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: "3.11"
18+
cache: "pip"
19+
20+
- name: Install pre-commit
21+
run: pip install -e ".[lint]"
22+
23+
- name: Run pre-commit
24+
run: pre-commit run --all-files

‎.github/workflows/publish.yaml

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
2+
# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
3+
name: Publish to PyPI and TestPyPI
4+
5+
on: push
6+
7+
jobs:
8+
build:
9+
name: Build distribution 📦
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Set up Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: "3.x"
18+
- name: Rewrite image URLs
19+
run: >-
20+
sed
21+
--in-place
22+
-E 's|!\[([^]]*)\]\((\./)?([^)]*)\)|![\1](https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref_name }}/\3)|g'
23+
README.md
24+
- name: Install pypa/build
25+
run: >-
26+
python3 -m
27+
pip install
28+
build
29+
--user
30+
- name: Build a binary wheel and a source tarball
31+
run: python3 -m build
32+
- name: Store the distribution packages
33+
uses: actions/upload-artifact@v4
34+
with:
35+
name: python-package-distributions
36+
path: dist/
37+
38+
publish-to-pypi:
39+
name: >-
40+
Publish to PyPI
41+
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
42+
needs:
43+
- build
44+
runs-on: ubuntu-latest
45+
environment:
46+
name: pypi
47+
url: https://pypi.org/p/eoapi-auth-utils
48+
permissions:
49+
id-token: write # IMPORTANT: mandatory for trusted publishing
50+
51+
steps:
52+
- name: Download all the dists
53+
uses: actions/download-artifact@v4
54+
with:
55+
name: python-package-distributions
56+
path: dist/
57+
- name: Publish distribution 📦 to PyPI
58+
uses: pypa/gh-action-pypi-publish@release/v1
59+
60+
github-release:
61+
name: >-
62+
Sign the Python 🐍 distribution 📦 with Sigstore
63+
and upload them to GitHub Release
64+
needs:
65+
- publish-to-pypi
66+
runs-on: ubuntu-latest
67+
68+
permissions:
69+
contents: write # IMPORTANT: mandatory for making GitHub Releases
70+
id-token: write # IMPORTANT: mandatory for sigstore
71+
72+
steps:
73+
- name: Download all the dists
74+
uses: actions/download-artifact@v4
75+
with:
76+
name: python-package-distributions
77+
path: dist/
78+
- name: Sign the dists with Sigstore
79+
uses: sigstore/[email protected]
80+
with:
81+
inputs: >-
82+
./dist/*.tar.gz
83+
./dist/*.whl
84+
- name: Create GitHub Release
85+
env:
86+
GITHUB_TOKEN: ${{ github.token }}
87+
run: >-
88+
gh release create
89+
'${{ github.ref_name }}'
90+
--repo '${{ github.repository }}'
91+
--generate-notes
92+
- name: Upload artifact signatures to GitHub Release
93+
env:
94+
GITHUB_TOKEN: ${{ github.token }}
95+
# Upload to GitHub Release using the `gh` CLI.
96+
# `dist/` contains the built packages, and the
97+
# sigstore-produced signatures and certificates.
98+
run: >-
99+
gh release upload
100+
'${{ github.ref_name }}' dist/**
101+
--repo '${{ github.repository }}'
102+
103+
publish-to-testpypi:
104+
name: Publish to TestPyPI
105+
needs:
106+
- build
107+
runs-on: ubuntu-latest
108+
109+
environment:
110+
name: testpypi
111+
url: https://test.pypi.org/p/eoapi-auth-utils
112+
113+
permissions:
114+
id-token: write # IMPORTANT: mandatory for trusted publishing
115+
116+
steps:
117+
- name: Download all the dists
118+
uses: actions/download-artifact@v4
119+
with:
120+
name: python-package-distributions
121+
path: dist/
122+
- name: Publish distribution 📦 to TestPyPI
123+
uses: pypa/gh-action-pypi-publish@release/v1
124+
with:
125+
repository-url: https://test.pypi.org/legacy/
126+
continue-on-error: true
127+

‎.github/workflows/test.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
paths:
6+
- "**/*.py"
7+
- "pyproject.toml"
8+
9+
jobs:
10+
pytest:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: "3.11"
19+
cache: "pip"
20+
21+
- name: Install dependencies
22+
run: pip install -e ".[testing]"
23+
24+
- name: Run tests
25+
run: pytest

‎.gitignore

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
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+
# PyCharm
158+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160+
# and can be added to the global gitignore or merged into this file. For a more nuclear
161+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162+
#.idea/

‎.pre-commit-config.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
repos:
2+
- repo: https://github.com/PyCQA/isort
3+
rev: 5.13.2
4+
hooks:
5+
- id: isort
6+
language_version: python
7+
args: ["-m", "3", "--trailing-comma", "-l", "88"]
8+
9+
- repo: https://github.com/astral-sh/ruff-pre-commit
10+
rev: v0.4.4
11+
hooks:
12+
- id: ruff
13+
args: ["--fix"]
14+
- id: ruff-format
15+
16+
- repo: https://github.com/pre-commit/mirrors-mypy
17+
rev: v1.10.0
18+
hooks:
19+
- id: mypy
20+
language_version: python
21+
additional_dependencies:
22+
- types-requests
23+
- types-attrs
24+
- types-PyYAML

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Development Seed
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.

0 commit comments

Comments
 (0)