Skip to content

Commit

Permalink
Clean-up readme redundancies
Browse files Browse the repository at this point in the history
  • Loading branch information
birdsarah committed Mar 25, 2020
1 parent b523286 commit 67364c5
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 23 deletions.
17 changes: 15 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
============
Domain Utils
`domain_utils`
============


Expand All @@ -14,9 +14,22 @@ Domain Utils
:alt: Documentation Status


A collection of util functions for extracting domains from urls.

Repo: https://github.com/mozilla/domain_utils

Install::

pip install domain_utils

Use::

import domain_utils as du
# Return just the url `my.domain.cloudfront.net/a/path/to/a/file.html`
du.get_stripped_url('https://my.domain.cloudfront.net/a/path/to/a/file.html?a=1')
# Return just the eTLD+1 `domain.cloudfront.net`
du.get_stripped_url('https://my.domain.cloudfront.net/a/path/to/a/file.html?a=1')

A collection of util functions for extracting domains from urls.

This package was originally extracted from
openwpm-utils_.
Expand Down
21 changes: 1 addition & 20 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,9 @@
******
`domain_utils` documentation
******

`domain_utils` is a small package for parsing urls.

Repo: https://github.com/mozilla/domain_utils

Install::

pip install domain_utils

Use::

import domain_utils as du
# Return just the url `my.domain.cloudfront.net/a/path/to/a/file.html`
du.get_stripped_url('https://my.domain.cloudfront.net/a/path/to/a/file.html?a=1')
# Return just the eTLD+1 `domain.cloudfront.net`
du.get_stripped_url('https://my.domain.cloudfront.net/a/path/to/a/file.html?a=1')
.. include:: ../README.rst

.. toctree::
:maxdepth: 1
:caption: Contents:

readme
installation
modules
contributing
Expand Down
1 change: 0 additions & 1 deletion docs/readme.rst

This file was deleted.

0 comments on commit 67364c5

Please sign in to comment.