Skip to content

Commit e567e9e

Browse files
author
Christopher Anna
committed
Merge branch 'release/0.1.0'
Finished release 0.1.0. It already doesn't work, I think I messed up the packaging because endpointGroups is missing
2 parents 7d24c80 + 182c756 commit e567e9e

34 files changed

+2411
-623
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
*.log
33
*.txt
44
.vscode
5+
dist/
6+
*.egg-info
57
*__pycache__/*

Pipfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ name = "pypi"
55

66
[packages]
77
requests = "*"
8+
"urllib3" = "*"
89

910
[dev-packages]
1011
pydoc-markdown = "*"
1112
pylint = "*"
1213
rope = "*"
14+
"autopep8" = "*"
1315

1416
[requires]
1517
python_version = "3.6"

Pipfile.lock

Lines changed: 17 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,53 @@
11
# PyWormbase
2-
This package is an interface to the WormBase REST API. You can use it in your Python programs to retrieve data from the WormBase API without needing to learn the details of REST API interactions. The function names are intelligent and documentation is provided. This package is targeted toward Wormbase users who want to get data from Wormbase faster than using the web site.
2+
This package is an interface to the WormBase ParaSite REST API. You can use it in your Python programs to retrieve data from the WormBase API without needing to learn the details of REST API interactions. The function names are intelligent and documentation is provided. This package is targeted toward Wormbase users who want to get data from Wormbase faster than using the web site.
33

44
## Installation
5-
Coming soon!
6-
<!-- Installation is simple with `pip`. Simply run
5+
Installation is simple with `pip`. Simply run
76

87
```Python
98
> pip install pywormbase
109
```
1110

12-
to retrieve this package from the PyPI package index. -->
11+
to retrieve this package from the PyPI package index.
1312

1413
## Usage
15-
Wormbase's API is free and open. No credentials, keys, or tokens are needed to access it. This makes PyWormbase easy to use in scripts, too. First, import PyWormbase, then instantiate a PyWormbase object:
14+
Wormbase's API is free and open. No credentials, keys, or tokens are needed to access it. This makes PyWormbase easy to use in scripts, too. First, import PyWormbase, then instantiate a WormbaseClient object:
1615

1716
```Python
1817
>>> import pywormbase
1918
>>> api = pywormbase.WormbaseClient()
2019
```
2120

22-
A `WormbaseClient` object will have a variety of member functions that provide access to Wormbase API endpoints. You can use `dir(api)` to see all functions available (or read the associated documentation in `docs`).
21+
A `WormbaseClient` object will have a variety of member functions that provide access to Wormbase API endpoints. You can use `dir(api)` to see all functions available (or read the associated documentation in the Github wiki).
2322

2423
## Support
2524
If you use PyWormbase and are experiencing problems with the package, or if you have a request for an additional feature, please file an issue at https://github.com/c-anna/PyWormbase/issues.
2625

26+
A note: `PyWormbase` is a wrapper around the WormBase ParaSite REST API. This API is subject to change and so both the content and format of the responses may change infrequently. While every effort will be made to keep this package aligned with the output of the REST API, it is still possible for scripts relying on this package to change their execution results even if no code changes were made. If you use `PyWormbase` and notice a change in a function's execution, please open an issue on Github.
27+
2728
## License
28-
PyWormbase is free and open-source, licensed under the MIT license. If you are using this software academically or professionally, please acknowledge this package and my Github page, https://github.com/c-anna, somewhere in your final product.
29+
PyWormbase is free and open-source, licensed under the MIT license. If you are using this software academically or professionally, please acknowledge this package and my Github page, https://github.com/c-anna, somewhere in your final product.
30+
31+
```
32+
. . . . . . .
33+
. . _.-/`/`'-._
34+
. Thanks for using!. /_..--''''_-'
35+
. PyWormbase! . // \
36+
. . . . .` //-.__\_\.-'
37+
`..' _\\\// --.___ // ___.---.._
38+
_- /@/@\ \ ||`` `-_
39+
.' ,\_\_/ | \_||_/ ,-._ `.
40+
; { o / } "" `-._`. ;
41+
; `-==-' / \_| ;
42+
| |>o<| }@@@} |
43+
| <(___<) }@@@@} |
44+
| <(___<) }@@@@@} |
45+
| <\___<) \_.?@@} |
46+
; V`--V`__./@} ;
47+
\ tx ooo@} /
48+
\ /
49+
`. .'
50+
`-._ _.-'
51+
``------'''''''''------``
52+
```
53+

docs/_build/pydocmd/basics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ __Example__
3030
{'status_code': 200, 'data': {'wbps_release': '9', 'wb_release': '258'}}
3131
```
3232

33-
See also: http://parasite.wormbase.org/rest/
33+
__See also: http://parasite.wormbase.org/rest/__
34+
3435

0 commit comments

Comments
 (0)