Skip to content

Commit

Permalink
update release documentation to use twine (because otherwise didnt wo…
Browse files Browse the repository at this point in the history
…rk for me)
  • Loading branch information
catstavi committed Jun 8, 2021
1 parent 3bdaab1 commit 9b1b927
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# socrata-py
Python SDK for the Socrata Data Management API. Use this library to call into publishing and ETL functionality offered when writing to Socrata datasets.
Python SDK for the Socrata Data Management API. Use this library to call into publishing and ETL functionality offered when writing to Socrata datasets.

```python
with open('cool_dataset.csv', 'rb') as file:
(revision, output) = Socrata(auth).create(
name = "cool dataset",
description = "a description"
).csv(file)

revision.apply(output_schema = output)
```

Expand Down Expand Up @@ -526,9 +526,30 @@ make docs
```

## Releasing
release to pypi by bumping the version to something reasonable and running
You will need to have twine installed, and a `.pypirc` file that includes credentials for uploading to both pypi and socrata artifactory.
An example file looks like:
```
[distutils]
index-servers =
local
pypi
[local]
repository: https://repo.socrata.com/artifactory/api/pypi/pypi
username: shared-engr
password: <REDACTED>
[pypi]
repository=https://upload.pypi.org/legacy/
username=socrata
password=<REDACTED>
```

Make sure the version in setup.py is new and makes sense for the change you're releasing. Then run:

```
python setup.py sdist upload -r pypi
python setup.py sdist
twine upload dist/socrata-py-
```
Note you'll need your `.pypirc` file in your home directory. For help, read [this](https://web.archive.org/web/20180523182143/http://peterdowns.com/posts/first-time-with-pypi.html)

Expand Down

0 comments on commit 9b1b927

Please sign in to comment.