Skip to content

Commit

Permalink
add build/publish instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
masci committed Nov 10, 2023
1 parent c81514a commit 8b24030
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ When your custom document store is ready and working, feel free to add it to the
[this repo](https://github.com/deepset-ai/haystack-integrations).


## Testing
## Test

You can use `hatch` to run the linters:

Expand All @@ -57,6 +57,27 @@ Similar for running the tests:
cmd [1] | coverage run -m pytest tests
...
```

## Build

To build the package you can use `hatc`:

```console
~$ hatch build
[sdist]
dist/example_store-0.0.1.tar.gz

[wheel]
dist/example_store-0.0.1-py3-none-any.whl
```

## Release

To automatically build and push the package to PyPI, you need to set a repository secret called `PYPI_API_TOKEN`
containing a valid token for your PyPI account.
Then set the desired version number in `src/example_store/__about__.py` and tag the commit using the format
`vX.Y.Z`. After pushing the tag, a Github workflow will start and take care of building and releasing the package.

## License

`example-store` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

0 comments on commit 8b24030

Please sign in to comment.