Package_name

Short description.

• Package_name
  • What is this?
  • Installation
    • via git clone
    • via pip install (recommended)
  • Getting started
  • Usage
  • Contributing
  • Help
    • FAQ
    • Getting pip
  • License

What is this?

"Optional quote" - Johnny Appleseed

Long desc.

Installation

Optional notice

via git clone

You can clone this repository, run cd package_root_folder_name, and then run pip install . or pip3 install . (or python3 -m pip install .).

Here's the complete installation script:

/usr/bin/git clone https://github.com/ThatXliner/package_name.git
cd package_root_folder_name
/usr/bin/pip3 install . || /usr/bin/python3 -m pip install .

or, a one-liner installation script:

/usr/bin/git clone https://github.com/ThatXliner/package_name.git && cd package_root_folder_name && /usr/bin/pip3 install . || /usr/bin/python3 -m pip install .

But, you can make pip do all of this by doing:

/usr/bin/python3 -m pip install git+https://github.com/ThatXliner/Pytemplate.git

NOTE: If you don't have pip or /usr/bin/pip or /usr/bin/pip3 (and have tried /usr/bin/python3 -m pip), you will need to install pip. See here to find out how to get pip.

via pip install (recommended)

You can easily install this package via pip install package_name (or python3 -m pip install package_name).

Getting started

Only have this sub-heading if the package is an importable python module.

Usage

pass

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

CONTRIBUTING.md

Help

FAQ

No questions were asked.

Getting pip

This project supports python 3.6 and higher. To install pip for python 3.6 (or higher) execute the following command in your shell (replace python3 with your python executable):

python3 -m ensurepip --upgrade

OR, as a last resort:

{/usr/bin/curl https://bootstrap.pypa.io/get-pip.py | /usr/bin/python3} || {wget https://bootstrap.pypa.io/get-pip.py | /usr/bin/python3} ||  {/usr/bin/curl https://bootstrap.pypa.io/get-pip.py | /usr/bin/python} ||  {wget https://bootstrap.pypa.io/get-pip.py | /usr/bin/python}

License

GNU GPL v3.0 unless noted otherwise. If you want to use this code for proprietary use, contact me