Skip to content

Commit

Permalink
Update README and docs index
Browse files Browse the repository at this point in the history
  • Loading branch information
parafoxia committed Nov 13, 2021
1 parent 8ddb70d commit 99db467
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 27 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# analytix

[![PyPi version](https://img.shields.io/pypi/v/analytix.svg)](https://pypi.python.org/pypi/analytix/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/analytix.svg)](https://pypi.python.org/pypi/analytix/)
[![PyPI - Implementation](https://img.shields.io/pypi/implementation/analytix)](https://pypi.python.org/pypi/analytix/)
[![PyPI - Status](https://img.shields.io/pypi/status/analytix)](https://pypi.python.org/pypi/analytix/)
[![Downloads](https://pepy.tech/badge/analytix)](https://pepy.tech/project/analytix)

[![Maintenance](https://img.shields.io/maintenance/yes/2021)](https://github.com/parafoxia/analytix)
[![GitHub Release Date](https://img.shields.io/github/release-date/parafoxia/analytix)](https://github.com/parafoxia/analytix)
[![GitHub last commit](https://img.shields.io/github/last-commit/parafoxia/analytix)](https://github.com/parafoxia/analytix)
[![Read the Docs](https://img.shields.io/readthedocs/analytix)](https://analytix.readthedocs.io/en/latest/index.html)
[![License](https://img.shields.io/github/license/parafoxia/analytix.svg)](https://github.com/parafoxia/analytix/blob/main/LICENSE)

[![CI (Tests)](https://github.com/parafoxia/analytix/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/parafoxia/analytix/actions/workflows/ci-tests.yml)
[![Read the Docs](https://img.shields.io/readthedocs/analytix)](https://analytix.readthedocs.io/en/latest/index.html)
[![Maintainability](https://api.codeclimate.com/v1/badges/8819bdebb2d4aa8dfcb7/maintainability)](https://codeclimate.com/github/parafoxia/analytix/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/8819bdebb2d4aa8dfcb7/test_coverage)](https://codeclimate.com/github/parafoxia/analytix/test_coverage)

A simple yet powerful wrapper for the YouTube Analytics API.

CPython versions 3.6 through 3.11-dev and PyPy versions 3.6 and 3.7 are officially supported.

Windows, MacOS, and Linux are all supported.

## Features

- Pythonic syntax lets you feel right at home
Expand All @@ -24,7 +27,7 @@ A simple yet powerful wrapper for the YouTube Analytics API.

## Installation

**You need Python 3.6.0 or greater to run analytix.** It is recommended you install analytix in a virtual environment. **Note**: While analytix supports Python 3.10, pandas does not. You will be able to retrieve reports and save them locally, but you won't be able to convert them to DataFrame objects.
**You need Python 3.6.0 or greater to run analytix.**

To install the latest stable version of analytix, use the following command:
```sh
Expand All @@ -38,7 +41,7 @@ pip install "analytix[opt]"

You can also install the latest development version using the following command:
```sh
pip install git+https://github.com/parafoxia/analytix@develop
pip install git+https://github.com/parafoxia/analytix
```

You may need to prefix these commands with a call to the Python interpreter depending on your OS and Python configuration.
Expand Down
41 changes: 22 additions & 19 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@ analytix
:alt: PyPI version
:target: https://pypi.python.org/pypi/analytix/

.. image:: https://img.shields.io/pypi/pyversions/analytix.svg
:alt: PyPI pyversions
:target: https://pypi.python.org/pypi/analytix/

.. image:: https://img.shields.io/pypi/implementation/analytix
:alt: PyPI - Implementation
:target: https://pypi.python.org/pypi/analytix/

.. image:: https://img.shields.io/pypi/status/analytix
:alt: PyPI - Status
:target: https://pypi.python.org/pypi/analytix/
Expand All @@ -21,25 +13,33 @@ analytix
:alt: Downloads
:target: https://pepy.tech/project/analytix

.. image:: https://img.shields.io/maintenance/yes/2021
:alt: Maintenance
:target: https://github.com/parafoxia/analytix

.. image:: https://img.shields.io/github/release-date/parafoxia/analytix
:alt: GitHub Release Date
:target: https://github.com/parafoxia/analytix

.. image:: https://img.shields.io/github/last-commit/parafoxia/analytix
:alt: GitHub last commit
:target: https://github.com/parafoxia/analytix

.. image:: https://img.shields.io/github/license/parafoxia/analytix.svg
:alt: License
:target: https://github.com/parafoxia/analytix/blob/main/LICENSE

|
.. image:: https://github.com/parafoxia/analytix/actions/workflows/ci-tests.yml/badge.svg
:target: https://github.com/parafoxia/analytix/actions/workflows/ci-tests.yml
:alt: CI (Tests)

.. image:: https://img.shields.io/readthedocs/analytix
:alt: Read the Docs
:target: https://analytix.readthedocs.io/en/latest/index.html

.. image:: https://img.shields.io/github/license/parafoxia/analytix.svg
:alt: License
:target: https://github.com/parafoxia/analytix/blob/main/LICENSE
.. image:: https://api.codeclimate.com/v1/badges/8819bdebb2d4aa8dfcb7/maintainability
:alt: Maintainability
:target: https://codeclimate.com/github/parafoxia/analytix/maintainability

.. image:: https://api.codeclimate.com/v1/badges/8819bdebb2d4aa8dfcb7/test_coverage
:alt: Test Coverage
:target: https://codeclimate.com/github/parafoxia/analytix/test_coverage

|
A simple yet powerful wrapper for the YouTube Analytics API.

Expand All @@ -52,6 +52,9 @@ Features
- Extra support allows the native saving of CSV files and conversion to DataFrame objects
- Easy enough for beginners, but powerful enough for advanced users

Contents
========

.. toctree::
:maxdepth: 1
:caption: Quickstart
Expand Down

0 comments on commit 99db467

Please sign in to comment.