Skip to content
This repository was archived by the owner on Aug 20, 2025. It is now read-only.

Commit 4938f78

Browse files
committed
updating README and setup.py
1 parent bb123c5 commit 4938f78

File tree

2 files changed

+13
-32
lines changed

2 files changed

+13
-32
lines changed

README.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
1-
python-ctapi
2-
============
3-
1+
# python-ctapi
42
Python interface for [CoinTracking.info API](https://cointracking.info/api/api.php).
53

64
I am not associated to cointracking.info -- use at your own risk!
75

8-
Requirements:
9-
=============
10-
11-
- requests
6+
# Requirements:
7+
* requests
128

13-
Install
14-
=======
15-
16-
```
17-
python setup.py install
18-
```
19-
20-
How to Use
21-
==========
9+
# Install
10+
`python setup.py install`
11+
`pip install python-ctapi`
2212

13+
# How to Use
2314
This is an example about how you can use the library
2415

2516
```
2617
#!/usr/bin/env python2
2718
28-
from ctapi.ctapi import CTAPI
19+
from ctapi import CTAPI
2920
3021
api_key = <YourAPIKey>
3122
api_secret = <YourAPISecret>
@@ -37,7 +28,6 @@ trades = api.getTrades()
3728
if trades['success']:
3829
for t in trades['result']:
3930
print trades['result'][t]
40-
4131
else:
4232
print "got no orders"
4333
@@ -48,21 +38,12 @@ print api.getGroupedBalance()
4838
print api.getGains()
4939
```
5040

51-
Running Tests
52-
=============
53-
54-
```
55-
venv/bin/python -m unittest -v ctapi.test.ctapi_tests
56-
```
57-
41+
# Running Tests
5842
**be aware of the API requests limit of 20 req/h**
43+
`venv/bin/python -m unittest -v ctapi.test.ctapi_tests`
5944

60-
Contribute
61-
==========
62-
45+
# Contribute
6346
Do you have an idea or found a bug in python-ctapi? Please file an issue and make a PR! :)
6447

65-
Support Me
66-
----------
67-
48+
## Support Me
6849
If you like the API and wanna support its developer, use the following referral link when registering at cointracking: https://cointracking.info?ref=T161519

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
setup(
66
name='python-ctapi',
77
version='0.2.0',
8-
packages=find_packages('ctapi'),
8+
packages=['ctapi'],
99
install_requires=[
1010
'requests==2.18.4',
1111
'future==0.16.0',

0 commit comments

Comments
 (0)