├── .dockerignore
├── .github
└── workflows
│ ├── docs.yml
│ ├── release.yml
│ ├── style.yml
│ └── tests.yml
├── .gitignore
├── .readthedocs.yaml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── docs
├── changelog.md
├── conf.py
├── contributing.md
├── index.md
└── reference.rst
├── pyproject.toml
├── src
└── pyforce
│ ├── __init__.py
│ ├── commands.py
│ ├── exceptions.py
│ ├── models.py
│ ├── py.typed
│ └── utils.py
└── tests
├── conftest.py
└── test_commands.py
/.dockerignore:
--------------------------------------------------------------------------------
1 | /.venv
2 | __pycache__
3 | *.egg-info
4 | *.pyc
5 | /dist
6 | /.mypy_cache
7 |
--------------------------------------------------------------------------------
/.github/workflows/docs.yml:
--------------------------------------------------------------------------------
1 | name: Docs
2 |
3 | on:
4 | push:
5 | branches: [main]
6 | pull_request:
7 | branches: [main]
8 |
9 | jobs:
10 | build:
11 | name: Test build docs
12 | runs-on: ubuntu-latest
13 | steps:
14 | - uses: actions/checkout@v4
15 | - uses: actions/setup-python@v5
16 | with:
17 | python-version: "3.12"
18 | cache: pip
19 | - name: install requirements
20 | run: |
21 | python -im pip install --upgrade pip
22 | python -im pip install .[docs]
23 | - name: Build docs
24 | run: |
25 | python -m sphinx -W -n -b html -a docs docs/_build
26 |
27 | linkcheck:
28 | name: Linkcheck
29 | runs-on: ubuntu-22.04
30 | steps:
31 | - uses: actions/checkout@v4
32 | - uses: actions/setup-python@v5
33 | with:
34 | python-version: "3.12"
35 | cache: "pip"
36 | - name: install requirements
37 | run: |
38 | python -im pip install --upgrade pip
39 | python -im pip install .[docs]
40 | - name: Linkcheck docs
41 | run: python -m sphinx -b linkcheck -a docs docs/_build/linkcheck
42 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: Release
2 |
3 | on:
4 | push:
5 | branches: [main]
6 | tags: ["*"]
7 | pull_request:
8 | branches: [main]
9 |
10 | jobs:
11 | build:
12 | name: Build package
13 | runs-on: ubuntu-latest
14 | outputs:
15 | version: ${{ steps.build.outputs.version }}
16 | steps:
17 | - uses: actions/checkout@v4
18 | with:
19 | fetch-depth: 0
20 | - uses: actions/setup-python@v5
21 | with:
22 | python-version: "3.12"
23 | cache: pip
24 | - name: Install requirements
25 | run: |
26 | python -Im pip install --upgrade pip
27 | python -Im pip install build check-wheel-contents hatch hatch-vcs
28 | - name: Build package
29 | id: build
30 | run: |
31 | python -Im build
32 | echo "version=$(python -m hatchling version)" | tee -a "$GITHUB_OUTPUT"
33 | - name: Check wheel content
34 | run: check-wheel-contents dist/*.whl
35 | - name: Print package contents summary
36 | run: |
37 | echo -e 'SDist Contents
\n' >> $GITHUB_STEP_SUMMARY
38 | tar -tf dist/*.tar.gz | tree -a --fromfile . | sed 's/^/ /' | tee -a $GITHUB_STEP_SUMMARY
39 | echo -e 'Wheel Contents
\n' >> $GITHUB_STEP_SUMMARY
41 | unzip -Z1 dist/*.whl | tree -a --fromfile . | sed 's/^/ /' | tee -a $GITHUB_STEP_SUMMARY
42 | echo -e '