Skip to content

Commit afecf9d

Browse files
committed
DEP: Remove tox
1 parent 1dda49f commit afecf9d

File tree

5 files changed

+16
-67
lines changed

5 files changed

+16
-67
lines changed

README.md

-6
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,6 @@ Then, from the repository root, run
9393
python3 -m unittest
9494
```
9595

96-
or
97-
98-
```shell
99-
tox
100-
```
101-
10296
## Contributing
10397

10498
Take a look at our [contributing](/docs/contributing.md) page.

docs/contributing.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# Contributing
22

33
## Developing the SDK
4+
45
- We follow a test-driven development (TDD) approach and require a high test coverage of each PR.
56
- We use [`pre-commit`](https://pre-commit.com/) to apply consistent code quality checks and linting to new code, commit messages, and documentation - see [below](#pre-commit) for how to set this up
67
- Documentation is automatically built by `pre-commit` but needs to be updated with any changes to public interface of the package
78

8-
99
## Releases
10+
1011
We use continuous deployment and semantic versioning for our releases:
12+
1113
- Continuous deployment - each pull request into `main` constitutes a new version
1214
- [Semantic versioning](https://semver.org/) supported by [Conventional Commits](https://github.com/octue/conventional-commits) - to automate meaningful version numbering
1315
- Conventional Commit messages - these are essential for the above to be automated. We've developed a `pre-commit` check that guides and enforces this.
1416

15-
1617
## Pull requests
1718

1819
### Internal developers
20+
1921
1. Check out a new branch
2022
2. Create a pull request into the `main` branch
2123
3. Undertake your changes, committing and pushing to your branch
@@ -27,11 +29,13 @@ We use continuous deployment and semantic versioning for our releases:
2729
9. Merge into `main`. A release will automatically be created on GitHub and published to PyPi and Docker Hub.
2830

2931
### External developers
32+
3033
- Please [raise an issue](https://github.com/octue/octue-sdk-python/issues) (or add your $0.02 to an existing issue) so
3134
the maintainers know what's happening and can advise/steer you.
3235

3336
- Create a fork of `octue-sdk-python`, undertaking your changes on a new branch, (see `.pre-commit-config.yaml` for
3437
branch naming conventions). To run tests and make commits, you'll need to do something like:
38+
3539
```
3640
git clone <your_forked_repo_address> # Fetches the repo to your local machine
3741
cd octue-sdk-python # Move into the repo directory
@@ -40,17 +44,18 @@ We use continuous deployment and semantic versioning for our releases:
4044
pip install poetry # Installs the poetry package manager
4145
poetry install --all-extras # Installs the package editably, including developer dependencies (e.g. testing and code formatting utilities)
4246
pre-commit install && pre-commit install -t commit-msg # Installs the pre-commit hooks in the git repo
43-
tox # Runs the tests
47+
poetry run python3 -m unittest # Runs the tests
4448
```
4549

4650
- Open a pull request into the `main` branch of `octue/octue-sdk-python`.
4751
- Follow the rest of the process for internal developers above.
4852
- Once checks have passed, test coverage of the new code is 100%, documentation is updated, and the review has passed,
4953
we'll merge and release your changes.
5054

51-
5255
## Pre-Commit
56+
5357
You need to install pre-commit to get the hooks working. Run:
58+
5459
```
5560
pip install pre-commit
5661
pre-commit install && pre-commit install -t commit-msg
@@ -74,16 +79,18 @@ Upon failure, the commit will halt. **Re-running the commit will automatically f
7479
- Commit messages - the error messages should explain how to fix these too
7580

7681
You can run pre-commit hooks without making a commit, too, like:
82+
7783
```
7884
pre-commit run black --all-files
7985
```
86+
8087
or
88+
8189
```
8290
# -v gives verbose output, useful for figuring out why docs won't build
8391
pre-commit run build-docs -v
8492
```
8593

86-
8794
## Documentation
8895

8996
### Building documents automatically
@@ -93,19 +100,20 @@ The documentation will build automatically in a pre-configured environment when
93100
In fact, the way `pre-commit` works, you won't be allowed to make the commit unless the documentation builds. This way
94101
we avoid getting broken documentation pushed to the main repository on any commit so we can rely on builds working.
95102

96-
97103
### Building documents manually
98104

99105
**If you did need to build the documentation**
100106

101107
Install `doxygen`. On a mac, that's `brew install doxygen`; other systems may differ.
102108

103109
Install sphinx and other requirements for building the docs:
110+
104111
```
105112
pip install -r docs/requirements.txt
106113
```
107114

108115
Run the build process:
116+
109117
```
110118
sphinx-build -b html docs/source docs/html
111119
```

poetry.lock

+2-40
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ octue = "octue.cli:octue_cli"
4848
# Testing
4949
gcp-storage-emulator = "2022.06.11"
5050
pytest = "^7"
51-
tox = "^3.23"
5251
# Code quality
5352
pre-commit = "^2.17"
5453
coverage = "^5"

tox.ini

-14
This file was deleted.

0 commit comments

Comments
 (0)