Skip to content

Commit 076989f

Browse files
committed
Update installation instructions after PyPI publication
Package is now available on PyPI! Update all installation instructions: - Remove 'not yet on PyPI' warnings - Show simple 'pip install pycancensus' as primary method - Keep GitHub installation as alternative for development versions Users can now install with: - pip install pycancensus - uv pip install pycancensus - poetry add pycancensus Published at: https://pypi.org/project/pycancensus/0.1.0/
1 parent 6d3d5f3 commit 076989f

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,26 @@ Access, retrieve, and work with Canadian Census data and geography.
4848

4949
## Installation
5050

51-
**Note**: pycancensus is not yet published on PyPI. Install directly from GitHub:
51+
Install from PyPI:
52+
53+
```bash
54+
pip install pycancensus
55+
```
56+
57+
Or install the latest development version from GitHub:
5258

5359
```bash
54-
# Install latest version from GitHub
5560
pip install git+https://github.com/dshkol/pycancensus.git
5661
```
5762

58-
Or for development:
63+
For development:
5964

6065
```bash
6166
git clone https://github.com/dshkol/pycancensus.git
6267
cd pycancensus
6368
pip install -e .[dev]
6469
```
6570

66-
**Coming soon**: Publication to PyPI for `pip install pycancensus`
67-
6871
## API Key
6972

7073
**pycancensus** requires a valid CensusMapper API key to use. You can obtain a free API key by [signing up](https://censusmapper.ca/users/sign_up) for a CensusMapper account.

docs/index.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Key Features
2626
Quick Start
2727
-----------
2828

29-
Install pycancensus from GitHub (not yet on PyPI):
29+
Install pycancensus:
3030

3131
.. code-block:: bash
3232
33-
pip install git+https://github.com/dshkol/pycancensus.git
33+
pip install pycancensus
3434
3535
Get started with basic census data:
3636

@@ -51,14 +51,17 @@ Get started with basic census data:
5151
Installation
5252
------------
5353

54-
**Note:** pycancensus is not yet published on PyPI. Install directly from GitHub:
54+
Install from PyPI:
5555

5656
.. code-block:: bash
5757
58-
# Install latest version
59-
pip install git+https://github.com/dshkol/pycancensus.git
58+
pip install pycancensus
59+
60+
Or install the latest development version from GitHub:
6061

61-
**Coming soon:** Publication to PyPI for ``pip install pycancensus``
62+
.. code-block:: bash
63+
64+
pip install git+https://github.com/dshkol/pycancensus.git
6265
6366
For development:
6467

0 commit comments

Comments
 (0)