Upping version

This commit is contained in:
Michael Lazar
2017-12-30 20:15:15 -05:00
parent 9eb1bde2e7
commit 5f365b8085
9 changed files with 62 additions and 18 deletions

View File

@@ -0,0 +1,35 @@
Release Checklist
-----------------
1. Switch to the master branch and stash any uncommited changes.
2. Bump the version number in [rtv/\_\_version\_\_.py](rtv/__version__.py).
3. Update the release notes in the [CHANGELOG.rst](CHANGELOG.rst).
4. Update the contributer list by running [``scripts/build_authors.py``](scripts/build_authors.py).
5. Re-generate the manpage by running [``scripts/build_manpage.py``](scripts/build_manpage.py).
6. Make sure the bundled packages are up-to-date by running [``scripts/update_packages.py``](scripts/update_packages.py).
7. Commit all changes to the master branch.
8. Clean out any old build/release files by running [``scripts/pip_clean.py``](scripts/pip_clean.py).
9. Build the source tarball and binary wheel: ``$ python3 setup.py sdist bdist_wheel``
10. Upload the packages to PyPI: ``$ twine upload dist/*``
11. Verify that the upload was successful: ``$ pip install rtv --upgrade --force-reinstall``
12. Smoke test the new release on Python 2 and Python 3.
12. Create a new release on Github and copy the release notes from the changelog.
13. Use Github to delete any old branches that have been merged.
Packaging Guide
---------------
The most up-to-date and pragmatic guide on packaging for PyPI is given here (as of Fall 2017):
https://packaging.python.org/tutorials/distributing-packages/
PyPI Credentials
----------------
PyPI credentials are stored in plaintext in the **~/.pypirc** file.
```
[pypi]
username = michael-lazar
password = secret
```

View File

@@ -26,6 +26,7 @@ def main():
parser = config.build_parser()
help_text = parser.format_help()
help_sections = help_text.split('\n\n')
del help_sections[1]
data = {}
print('Fetching version')

View File

@@ -9,19 +9,24 @@ RTV - Reddit Terminal Viewer
{options}
.SH CONTROLS
Move the cursor using the arrow keys or vim style movement.
.br
Press \fBup\fR and \fBdown\fR to scroll through submissions.
.br
Press \fBright\fR to view the selected submission and \fBleft\fR to return.
.br
Press \fB?\fR to open the help screen.
.SH FILES
.TP
.BR $XDG_CONFIG_HOME/rtv/rtv.cfg
The configuration file can be used to customize default program settings, see
README.md for more information.
The configuration file can be used to customize default program settings.
.TP
.BR $XDG_CONFIG_HOME/rtv/refresh-token
.BR $XDG_DATA_HOME/rtv/refresh-token
After you login to reddit, your most recent OAuth refresh token will be stored
for future sessions. You can disable this behavior by setting the option
\fBpersistent=False\fR in your configuration file.
for future sessions.
.TP
.BR $XDG_DATA_HOME/rtv/history.log
This file stores URLs that have been recently opened in order to
visually highlight them as "seen".
.SH ENVIRONMENT
.TP
.BR RTV_EDITOR