-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the readme for the example repo
- Loading branch information
1 parent
e165875
commit 68e7adb
Showing
1 changed file
with
4 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,6 @@ | ||
# django-commons-playground | ||
A sample project to test things out | ||
# Django Commons example repository | ||
|
||
This is an example repository for Django Commons. Some relevant areas to review are: | ||
|
||
## Running tests | ||
|
||
```shell | ||
python -m unittest | ||
``` | ||
|
||
## Manually building and uploading | ||
|
||
```shell | ||
python3 -m pip install -U twine build | ||
python3 -m build | ||
python3 -m twine upload --repository testpypi dist/* | ||
``` | ||
- GitHub action ([release.yml](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)) for releasing to PyPI | ||
- [Documentation](docs/README.md) |