forked from cjolowicz/hypermodern-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
The Hypermodern Python Project | ||
============================== | ||
|
||
The example project for the | ||
`Hypermodern Python <https://medium.com/@cjolowicz/hypermodern-python-d44485d9d769>`_ | ||
article series. | ||
The command-line interface prints random facts to your console, | ||
using the `Wikipedia API <https://en.wikipedia.org/api/rest_v1/#/>`_. | ||
|
||
|
||
Installation | ||
------------ | ||
|
||
To install the Hypermodern Python project, | ||
run this command in your terminal: | ||
|
||
.. code-block:: console | ||
$ pip install hypermodern-python | ||
Usage | ||
----- | ||
|
||
Hypermodern Python's usage looks like: | ||
|
||
.. code-block:: console | ||
$ hypermodern-python [OPTIONS] | ||
.. option:: -l <language>, --language <language> | ||
|
||
The Wikipedia language edition, | ||
as identified by its subdomain on | ||
`wikipedia.org <https://www.wikipedia.org/>`_. | ||
By default, the English Wikipedia is selected. | ||
|
||
.. option:: --version | ||
|
||
Display the version and exit. | ||
|
||
.. option:: --help | ||
|
||
Display a short usage message and exit. |