Skip to content

Commit 0e24a94

Browse files
committed
prepare first pypi release
1 parent 0d6cba6 commit 0e24a94

File tree

2 files changed

+6
-92
lines changed

2 files changed

+6
-92
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,3 @@
1-
See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
2-
description of best practices for developing scientific packages.
1+
Contributions are welcome, please see our documentation:
32

4-
[spc-dev-intro]: https://learn.scientific-python.org/development/
5-
6-
# Quick development
7-
8-
The fastest way to start with development is to use nox. If you don't have nox,
9-
you can use `pipx run nox` to run it without installing, or `pipx install nox`.
10-
If you don't have pipx (pip for applications), then you can install with
11-
`pip install pipx` (the only case were installing an application with regular
12-
pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
13-
`brew install pipx nox`.
14-
15-
To use, run `nox`. This will lint and test using every installed version of
16-
Python on your system, skipping ones that are not installed. You can also run
17-
specific jobs:
18-
19-
```console
20-
$ nox -s lint # Lint only
21-
$ nox -s tests # Python tests
22-
$ nox -s docs -- --serve # Build and serve the docs
23-
$ nox -s build # Make an SDist and wheel
24-
```
25-
26-
Nox handles everything for you, including setting up an temporary virtual
27-
environment for each run.
28-
29-
# Setting up a development environment manually
30-
31-
You can set up a development environment by running:
32-
33-
```bash
34-
python3 -m venv .venv
35-
source ./.venv/bin/activate
36-
pip install -v -e .[dev]
37-
```
38-
39-
If you have the
40-
[Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you
41-
can instead do:
42-
43-
```bash
44-
py -m venv .venv
45-
py -m install -v -e .[dev]
46-
```
47-
48-
# Pre-commit
49-
50-
You should prepare pre-commit, which will help you by checking that commits pass
51-
required checks:
52-
53-
```bash
54-
pip install pre-commit # or brew install pre-commit on macOS
55-
pre-commit install # Will install a pre-commit hook into the git repo
56-
```
57-
58-
You can also/alternatively run `pre-commit run` (changes only) or
59-
`pre-commit run --all-files` to check even without installing the hook.
60-
61-
# Testing
62-
63-
Use pytest to run the unit checks:
64-
65-
```bash
66-
pytest
67-
```
68-
69-
# Coverage
70-
71-
Use pytest-cov to generate coverage reports:
72-
73-
```bash
74-
pytest --cov=coincident
75-
```
76-
77-
# Building docs
78-
79-
You can build the docs using:
80-
81-
```bash
82-
nox -s docs
83-
```
84-
85-
You can see a preview with:
86-
87-
```bash
88-
nox -s docs -- --serve
89-
```
3+
https://coincident.readthedocs.io/en/latest/user_guide/contribute.html

.github/workflows/cd.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
subject-path: "dist/*"
5656

5757
- uses: pypa/gh-action-pypi-publish@release/v1
58-
with:
59-
# Remember to tell (test-)pypi about this repo before publishing
60-
# Remove this line to publish to PyPI
61-
repository-url: https://test.pypi.org/legacy/
58+
#with:
59+
# Remember to tell (test-)pypi about this repo before publishing
60+
# Remove this line to publish to PyPI
61+
#repository-url: https://test.pypi.org/legacy/

0 commit comments

Comments
 (0)