Skip to content

Commit 80f9ce0

Browse files
committed
docs: update documentation and remove unneeded files
1 parent 3af6ab5 commit 80f9ce0

File tree

3 files changed

+11
-60
lines changed

3 files changed

+11
-60
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ Python 3.8 and above are supported by the SDK.
1212

1313
### Installation and Dependencies
1414

15-
A [`Makefile`](./Makefile) has been included in the project which should make it straightforward to start the project locally. We utilize virtual environments (see [`virtualenv`](https://docs.python.org/3/tutorial/venv.html)) in order to provide isolated development environments for the project. This reduces the risk of invalid or corrupt global packages. It also integrates nicely with Make, which will detect changes in the `requirements.txt` file and update the virtual environment if any occur.
15+
We use [Hatch](https://hatch.pypa.io/) to manage the project. Hatch is does not have built-in support for monorepos yet, so you must run it inside each package directory.
1616

17-
Run `make init` to initialize the project's virtual environment and install all dev dependencies.
17+
To install Hatch, just run `pip install hatch`.
18+
19+
You will also need to setup the `pre-commit` hooks. Run `pre-commit install` in the root directory of the repository. If you don't have `pre-commit` installed, you can install it with `pip install pre-commit`.
1820

1921
### Testing
2022

21-
Run tests with `make test`.
23+
Run tests by entering the package directory and running `hatch run test`.
2224

2325
We use `pytest` for our unit testing, making use of `parametrized` to inject cases at scale.
2426

@@ -28,7 +30,10 @@ These are planned once the SDK has been stabilized and a Flagd provider implemen
2830

2931
### Packaging
3032

31-
We publish to the PyPI repository, where you can find this package at [openfeature-sdk-contrib](https://pypi.org/project/openfeature-sdk-contrib/).
33+
We publish to the PyPI repository, where you can find each individual package:
34+
35+
- [openfeature-provider-flagd](https://pypi.org/project/openfeature-provider-flagd/)
36+
- [openfeature-hooks-opentelemetry](https://pypi.org/project/openfeature-hooks-opentelemetry/)
3237

3338
## Pull Request
3439

@@ -55,7 +60,8 @@ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/python-sdk-contrib.g
5560
Ensure your development environment is all set up by building and testing
5661

5762
```bash
58-
make
63+
cd <package>
64+
hatch run test
5965
```
6066

6167
To start working on a new feature or bugfix, create a new branch and start working on it.

Makefile

Lines changed: 0 additions & 46 deletions
This file was deleted.

requirements.txt

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)