Skip to content

Commit

Permalink
[DevOps]: wasn't thinking - removing the m2r requirement and switchin…
Browse files Browse the repository at this point in the history
…g to rst
  • Loading branch information
jpetrucciani committed Sep 18, 2018
1 parent e9610f0 commit 0ad09dd
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 40 deletions.
35 changes: 0 additions & 35 deletions README.md

This file was deleted.

56 changes: 56 additions & 0 deletions README.rst
@@ -0,0 +1,56 @@

pyclickup
=========


.. image:: https://badge.fury.io/py/pyclickup.svg
:target: https://badge.fury.io/py/pyclickup
:alt: PyPI version


.. image:: https://travis-ci.org/jpetrucciani/pyclickup.svg?branch=master
:target: https://travis-ci.org/jpetrucciani/pyclickup
:alt: Build Status


.. image:: https://coveralls.io/repos/github/jpetrucciani/pyclickup/badge.svg?branch=master
:target: https://coveralls.io/github/jpetrucciani/pyclickup?branch=master
:alt: Coverage Status


.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Code style: black


A python wrapper for the ClickUp API

Quick start
-----------

Installation
^^^^^^^^^^^^

.. code-block:: bash
# install pyclickup
pip install pyclickup
Basic Usage
^^^^^^^^^^^

.. code-block:: python
from pyclickup import ClickUp
clickup = ClickUp('$ACCESS_TOKEN')
main_team = clickup.teams[0]
main_space = main_team.spaces[0]
members = main_space.members
main_project = main_space.projects[0]
main_list = main_project.lists[0]
tasks = main_list.get_all_tasks(include_closed=True)
1 change: 0 additions & 1 deletion dev-requirements.txt
Expand Up @@ -2,4 +2,3 @@ colorama==0.3.7
pytest==3.5.1
pytest-cov==2.5.1
coveralls==1.5.0
m2r==0.2.0
2 changes: 1 addition & 1 deletion pyclickup/globals.py
Expand Up @@ -3,7 +3,7 @@
"""


__version__ = "0.0.5"
__version__ = "0.0.6"


LIBRARY = "pyclickup"
Expand Down
5 changes: 2 additions & 3 deletions setup.py
Expand Up @@ -4,18 +4,17 @@
"""
from pyclickup.globals import __version__, LIBRARY
from setuptools import setup, find_packages
from m2r import convert


with open("README.md") as readme:
with open("README.rst") as readme:
long_description = readme.read()


setup(
name=LIBRARY,
version=__version__,
description="A python wrapper for the ClickUp API",
long_description=convert(long_description),
long_description=long_description,
author="Jacobi Petrucciani",
author_email="jacobi@mimirhq.com",
keywords="clickup python",
Expand Down

0 comments on commit 0ad09dd

Please sign in to comment.