Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/build-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ jobs:
run: |
mv README.PyPI.md.stub README.PyPI.md
tail -n +2 README.md >> README.PyPI.md
mv README.PyPI.md README.md
- name: Build using Poetry
run: |
poetry build
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ and configurations are documented
### Prerequisites

1. Download latest python from <https://www.python.org/downloads/>
2. Install required libraries using below command.
2. Once this repo is cloned install required libraries using:

```sh
pip install -r requirements.txt
pip install .
```

### GitHub Repository Clone
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ Older versions of this package will of course remain available on

## Getting Started

### 0. Use a virtual environment (venv)

Modern Linux distributions don't like you using `pip` to install Python
packages into the system namespace. So it's best to start with a virtual
environment ([venv](https://docs.python.org/3/library/venv.html)).

Even if you're using MacOS or Windows, it's highly recommended to start with a
venv.

We also suggest using [uv](https://docs.astral.sh/uv/) to create your venv and
install stuff into it.

### 1. Installation

This package can be installed from PyPI with:
Expand All @@ -36,7 +48,6 @@ pip install atsdk
Alternatively clone this repo and from the repo root:

```shell
pip install -r requirements.txt
pip install .
```

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description = "Python SDK for atPlatform"
authors = ["Umang Shah <shahumang19@gmail.com>","Chris Swan <chris@atsign.com>"]
maintainers = ["Chris Swan <chris@atsign.com>"]
license = "BSD-3-Clause"
readme = "README.PyPI.md"
readme = "README.md"
packages = [{include = "at_client"}]
homepage = "https://github.com/atsign-foundation/at_python"

Expand Down
Loading