Skip to content

Commit

Permalink
add build info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xavdid committed May 23, 2023
1 parent 84f310d commit c7f4f4c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,15 @@ When running the `user` command, yes. It fetches and updates up to 1k each of co
When running the `archive` command, no. To cut down on API requests, it only fetches data about comments/posts that aren't yet in the database (since the archive may include many items).

Both of these may change in the future to be more in line with [Reddit's per-subreddit archiving guidelines](https://www.reddit.com/r/modnews/comments/py2xy2/voting_commenting_on_archived_posts/).

## Releasing New Versions

> these notes are mostly for myself (or other contributors)
0. ensure tests pass (`pytest`)
1. install release tooling (`pip install -e '.[release]'`)
2. build the package (`python -m build`)
3. upload the release (`python -m twine upload dist/*`)
1. give your username as `__token__`
2. give your password as your stored API key
3. If you're getting invalid password, verify that `~/.pypirc` is empty
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ dependencies = [

[project.optional-dependencies]
test = ["pytest==7.3.1", "responses==0.23.1"]
release = ["twine==4.0.2", "build==0.10.0"]

[project.urls]
"Homepage" = "https://github.com/xavdid/reddit-user-to-sqlite"
Expand Down

0 comments on commit c7f4f4c

Please sign in to comment.