Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Commit

Permalink
Tweak documents
Browse files Browse the repository at this point in the history
  • Loading branch information
vfaronov committed Jun 27, 2019
1 parent d495fe3 commit dc5006d
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
33 changes: 25 additions & 8 deletions HACKING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,32 @@ Releasing a new version
Maintenance
~~~~~~~~~~~

- Watch for new versions of related software
and make sure they are compatible with HTTPolice:
- Run a fresh Travis build, look at its logs and make sure everything's right.

- main dependencies (``install_requires``);
- sources of input data (tcpflow, major Web browsers, Fiddler).
- Watch for new versions of Python:

- make sure HTTPolice works with them
- add them to Travis config
- update PyPI trove classifiers

- Watch for new versions of libraries and make sure HTTPolice works with them.

- Watch for new versions of software HTTPolice integrates with:

- tcpflow

- HAR exporters

- major Web browsers
- Fiddler

- mitmproxy

- Django

- Test HTML reports in current versions of major Web browsers.

- Watch for new RFCs and RFC errata that may affect HTTPolice rules.

- Update development dependencies:

Expand All @@ -241,10 +262,6 @@ Maintenance
#. Check that everything is OK with the new versions.
Maybe some Pylint overrides are no longer necessary, etc.

- Look at Travis build logs and make sure nothing strange is going on there.

- Check that the Python versions in PyPI trove classifiers are up to date.

- Check links in notices::

$ linkchecker --check-extern doc/_build/notices.html
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ See `example report`__.
__ https://httpolice.readthedocs.io/page/showcase.html

As a command-line tool, it can read `HAR files`__ or raw HTTP/1.x TCP streams.
It can integrate with `mitmproxy`__ for TLS-encrypted and HTTP/2 traffic.
It can `integrate with mitmproxy`__ for TLS-encrypted and HTTP/2 traffic.
Or you can use it as a Python (3.4+) library.
There is a `Django`__ integration package and a third-party `Chrome extension`__.
There is a `Django integration`__ package and a third-party `Chrome extension`__.

__ https://en.wikipedia.org/wiki/.har
__ https://mitmproxy.org/
__ https://www.djangoproject.com/
__ https://github.com/vfaronov/mitmproxy-httpolice
__ https://github.com/vfaronov/django-httpolice
__ https://chrome.google.com/webstore/detail/httpolice-devtool/hnlnhebgfcfemjaphgbeokdnfpgbnhgn

Start with the `quickstart`__.
Expand Down

0 comments on commit dc5006d

Please sign in to comment.