From 99db467e772a483e19efe68cce0c503b53716f4e Mon Sep 17 00:00:00 2001 From: Ethan Henderson Date: Sat, 13 Nov 2021 17:18:55 +0000 Subject: [PATCH] Update README and docs index --- README.md | 19 +++++++++++-------- docs/index.rst | 41 ++++++++++++++++++++++------------------- 2 files changed, 33 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index fb5cee8..c16443c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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. diff --git a/docs/index.rst b/docs/index.rst index 99f5711..715c21a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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/ @@ -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. @@ -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