Skip to content

Commit 0ad09dd

Browse files
committed
[DevOps]: wasn't thinking - removing the m2r requirement and switching to rst
1 parent e9610f0 commit 0ad09dd

File tree

5 files changed

+59
-40
lines changed

5 files changed

+59
-40
lines changed

README.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

README.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
pyclickup
3+
=========
4+
5+
6+
.. image:: https://badge.fury.io/py/pyclickup.svg
7+
:target: https://badge.fury.io/py/pyclickup
8+
:alt: PyPI version
9+
10+
11+
.. image:: https://travis-ci.org/jpetrucciani/pyclickup.svg?branch=master
12+
:target: https://travis-ci.org/jpetrucciani/pyclickup
13+
:alt: Build Status
14+
15+
16+
.. image:: https://coveralls.io/repos/github/jpetrucciani/pyclickup/badge.svg?branch=master
17+
:target: https://coveralls.io/github/jpetrucciani/pyclickup?branch=master
18+
:alt: Coverage Status
19+
20+
21+
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
22+
:target: https://github.com/ambv/black
23+
:alt: Code style: black
24+
25+
26+
A python wrapper for the ClickUp API
27+
28+
Quick start
29+
-----------
30+
31+
Installation
32+
^^^^^^^^^^^^
33+
34+
.. code-block:: bash
35+
36+
# install pyclickup
37+
pip install pyclickup
38+
39+
Basic Usage
40+
^^^^^^^^^^^
41+
42+
.. code-block:: python
43+
44+
from pyclickup import ClickUp
45+
46+
47+
clickup = ClickUp('$ACCESS_TOKEN')
48+
49+
main_team = clickup.teams[0]
50+
main_space = main_team.spaces[0]
51+
members = main_space.members
52+
53+
main_project = main_space.projects[0]
54+
main_list = main_project.lists[0]
55+
56+
tasks = main_list.get_all_tasks(include_closed=True)

dev-requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@ colorama==0.3.7
22
pytest==3.5.1
33
pytest-cov==2.5.1
44
coveralls==1.5.0
5-
m2r==0.2.0

pyclickup/globals.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"""
44

55

6-
__version__ = "0.0.5"
6+
__version__ = "0.0.6"
77

88

99
LIBRARY = "pyclickup"

setup.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@
44
"""
55
from pyclickup.globals import __version__, LIBRARY
66
from setuptools import setup, find_packages
7-
from m2r import convert
87

98

10-
with open("README.md") as readme:
9+
with open("README.rst") as readme:
1110
long_description = readme.read()
1211

1312

1413
setup(
1514
name=LIBRARY,
1615
version=__version__,
1716
description="A python wrapper for the ClickUp API",
18-
long_description=convert(long_description),
17+
long_description=long_description,
1918
author="Jacobi Petrucciani",
2019
author_email="jacobi@mimirhq.com",
2120
keywords="clickup python",

0 commit comments

Comments
 (0)