Skip to content

Commit 00bdbec

Browse files
committed
Add BSD-3-Clause license and clarify modern editable installs
1 parent a65f0eb commit 00bdbec

5 files changed

Lines changed: 55 additions & 6 deletions

File tree

‎.github/workflows/tests.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ jobs:
1313
- uses: actions/setup-python@v5
1414
with:
1515
python-version: ${{ matrix.python }}
16+
- run: python -m pip install --upgrade pip
1617
- run: python -m pip install '.[dev]'
1718
- run: python -m pytest
1819
- run: python -m build

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
__pycache__/
22
*.py[cod]
33
.pytest_cache/
4-
.venv/
4+
.venv*/
55
.env
66
.env.*
77
build/

‎LICENSE‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2026, Ryan Galloway
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,36 @@ BYO workers belong in the separate worker package, not this client.
66

77
## Development install
88

9-
Requires Python 3.10+.
9+
Requires Python 3.10+ and a modern pip (21.3+ for editable installs).
10+
Use a supported interpreter explicitly; the system `python3` may be older.
1011

1112
```bash
12-
python -m venv .venv
13+
python3.12 -m venv .venv
1314
source .venv/bin/activate
14-
pip install -e '.[dev]'
15+
python -m pip install --upgrade pip
16+
python -m pip install -e '.[dev]'
1517
pytest
1618
python -m build
1719
python -m twine check dist/*
1820
```
1921

20-
A package license must be selected before the first public release. CI builds and
21-
checks distributions but does not publish them.
22+
If pip reports that editable mode requires `setup.py`, check `python --version`
23+
and `python -m pip --version`. Python 3.8 is unsupported. Create a new environment
24+
with Python 3.10+ and upgrade pip there; upgrading pip alone cannot change its
25+
Python interpreter. A `setup.py` compatibility shim is not needed.
26+
27+
With [uv](https://docs.astral.sh/uv/), a supported Python can also be provisioned
28+
without changing the system Python. Preserve an existing environment by using a
29+
new directory:
30+
31+
```bash
32+
uv venv --python 3.12 .venv312
33+
source .venv312/bin/activate
34+
uv pip install -e '.[dev]'
35+
```
36+
37+
Licensed under [BSD-3-Clause](LICENSE). CI builds and checks distributions but does
38+
not publish them.
2239

2340
## Usage
2441

‎pyproject.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ name = "subfork"
77
version = "0.1.0a1"
88
description = "Python API client for Subfork graph authoring and execution"
99
readme = "README.md"
10+
license = "BSD-3-Clause"
11+
license-files = ["LICENSE"]
1012
requires-python = ">=3.10"
1113
dependencies = ["httpx>=0.28,<1"]
1214
classifiers = [

0 commit comments

Comments
 (0)