Skip to content

Commit bf6653e

Browse files
committed
added installation instructions
1 parent 6592bba commit bf6653e

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,17 @@ A `WideHelpFormatter` subclass with its `percentage_of_line_length` set to three
2424

2525
A `ThreeQuarterWidthHelpFormatter` subclass which also derives from `argparse.ArgumentDefaultsHelpFormatter`. This means that in addition to using 3/4 of the terminal line length, it also prints the argument defaults in the help text.
2626

27-
## Usage
27+
## Installation & Usage
2828

29-
Use these classes in the same way as any other `argparse.HelpFormatter` subclass while creating your argument parser:
29+
Install the package with your favourite python package manager:
30+
31+
pip install apextras
32+
33+
or directly into your [pipenv](https://pipenv.readthedocs.io/):
34+
35+
pipenv install apextras
36+
37+
After that, you can use these classes in the same way as any other `argparse.HelpFormatter` subclass while creating your argument parser:
3038

3139
from apextras.formatter import WideHelpFormatter
3240
parser = argparse.ArgumentParser(formatter_class=WideHelpFormatter)

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
long_description = fh.read()
55

66
setuptools.setup(
7-
name="apextras",
7+
name="apextras",
88
version="0.9.0",
99
author="David Zerrenner",
1010
author_email="[email protected]",
@@ -19,4 +19,4 @@
1919
"Operating System :: OS Independent",
2020
],
2121
python_requires='>=3.6',
22-
)
22+
)

0 commit comments

Comments
 (0)