Skip to content

docs: improve installation instructions #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anushree3412 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve installation instructions #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 18 additions & 21 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,48 @@
.. highlight:: shell

============
Installation
============


Stable release
--------------

To install chartify, run this command in your terminal:
To install Chartify, run the following command in your terminal:

.. code-block:: console

$ pip install chartify

This is the preferred method to install chartify, as it will always install the most recent stable release.
This installs the latest stable release of Chartify.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
If ``pip`` is not installed, refer to the `Python installation guide`_
for instructions.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
.. _Python installation guide:
https://docs.python.org/3/installing/

From source
-----------

From sources
------------
The Chartify source code is available in the `GitHub repository`_.

The sources for chartify can be downloaded from the `Github repo`_.

You can either clone the public repository:
To clone the repository using Git:

.. code-block:: console

$ git clone git://github.com/spotify/chartify
$ git clone https://github.com/spotify/chartify.git

Or download the `tarball`_:
You can also download the source as a tarball:

.. code-block:: console

$ curl -OL https://github.com/spotify/chartify/tarball/master
$ curl -O https://github.com/spotify/chartify/archive/refs/heads/master.tar.gz

Once you have a copy of the source, you can install it with:
Once you have a copy of the source, navigate to the Chartify directory
and install it with:

.. code-block:: console

$ cd chartify
$ python setup.py install


.. _Github repo: https://github.com/spotify/chartify
.. _tarball: https://github.com/spotify/chartify/tarball/master
.. _GitHub repository:
https://github.com/spotify/chartify