Skip to content

#3 - updated README with installation instructions #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 15, 2023
Merged

#3 - updated README with installation instructions #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ Basic packages containing all the Python dependencies for the Coder Dojo Session

## Installation

[//]: # (TODO: Update documentation)
You can install the package from GitHub using the following command.

```shell
pip install 'coder_dojo_common_python[games,data] @ https://github.com/Stedders/coder-dojo-common-python/releases/download/v0.0.1/coder_dojo_common_python-0.0.1-py3-none-any.whl'
```

This will install the games and data packages for the v0.0.1 release.

As packages are updated or new packages added a new version will be published, please check the latest version
at https://github.com/Stedders/coder-dojo-common-python/releases.

## Development

Expand All @@ -26,7 +35,8 @@ poetry add requests --optional

You will then need to update the extra information to ensure the package is in the correct group.

Either update the appropriate extras section or create a new section under extras in the [pyproject.toml](pyproject.toml) file.
Either update the appropriate extras section or create a new section under extras in
the [pyproject.toml](pyproject.toml) file.

```toml
[tool.poetry.dependencies]
Expand Down