Skip to content

Improve documentation a bit #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pwildenhain merged 1 commit into from
Mar 23, 2021
Merged

Improve documentation a bit #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Install extra requirements, which allows returning project data as a :code:`pand
Install from GitHub
::

$ git clone git://github.com/sburns/PyCap.git PyCap
$ git clone git://github.com/redcap-tools/PyCap.git PyCap
$ cd PyCap
$ python setup.py install

Expand Down Expand Up @@ -156,4 +156,4 @@ If you use PyCap in your research, please consider citing the software:

Burns, S. S., Browne, A., Davis, G. N., Rimrodt, S. L., & Cutting, L. E. PyCap (Version 1.0) [Computer Software].
Nashville, TN: Vanderbilt University and Philadelphia, PA: Childrens Hospital of Philadelphia.
Available from https://github.com/sburns/PyCap. doi:10.5281/zenodo.9917
Available from https://github.com/redcap-tools/PyCap. doi:10.5281/zenodo.9917
6 changes: 3 additions & 3 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Issues & Contributing
=====================

If you have an issue with PyCap or the REDCap API, please raise an issue on PyCap's `issues page <http://github.com/sburns/PyCap/issues>`_. I'll do my best to help where I can.
If you have an issue with PyCap or the REDCap API, please raise an issue on PyCap's `issues page <https://github.com/redcap-tools/PyCap/issues>`_. We'll do our best to help where we can.

PyCap follows the `Fork-Pull workflow <https://help.github.com/articles/using-pull-requests#fork--pull>`_ method for accepting contributions. If you'd like to contribute code to PyCap, please use the following workflow:

1. If you don't already have an account on GitHub, please make one.
2. Fork `my repo <http://github.com/sburns/PyCap>`_ to your own account.
2. Fork `my repo <https://github.com/redcap-tools/PyCap>`_ to your own account.
3. Checkout a branch & commit your changes. Tests are definitely appreciated!
4. Push those changes to your repo & submit a Pull-Request to my repository.

If any of these steps are unclear, please peruse the helpful `GitHub Guide on Forking <https://guides.github.com/activities/forking/>`_ or reach out to me on `Twitter <http://twitter.com/scottsburns>`_.
If any of these steps are unclear, please peruse the helpful `GitHub Guide on Forking <https://guides.github.com/activities/forking/>`_ or file an issue, and we'll try to help out!
12 changes: 7 additions & 5 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
PyCap
=====

PyCap is an interface to the `REDCap <http://www.project-redcap.org>`_ Application Programming Interface (API). PyCap is designed to be a minimal interface exposing all required and optional API parameters. My hope is that it makes simple things easy & hard things possible.
PyCap is an interface to the `REDCap <http://www.project-redcap.org>`_ Application Programming Interface (API). PyCap is designed to be a minimal interface exposing all required and optional API parameters. Our hope is that it makes simple things easy & hard things possible.

Installation
------------
Expand All @@ -15,11 +15,13 @@ Install the latest version with `pip <https://pypi.python.org/pypi/pip>`_::

$ pip install PyCap

To install the bleeding edge from the github repo, use the following::
If you want to load REDCap data into `pandas <https://github.com/redcap-tools/PyCap>`_ dataframes, this will make sure you have pandas installed::

$ pip install 'PyCap[pandas]'

$ pip install -e git+https://github.com/sburns/PyCap.git#egg=PyCap
To install the bleeding edge from the github repo, use the following::

The only requirement is `requests <http://python-requests.org>`_ which will be installed automatically for you by ``pip``.
$ pip install -e git+https://github.com/redcap-tools/PyCap.git#egg=PyCap

Philosophy
----------
Expand All @@ -40,7 +42,7 @@ If you use PyCap in your research, please consider citing the software:

Burns, S. S., Browne, A., Davis, G. N., Rimrodt, S. L., & Cutting, L. E. PyCap (Version 1.0) [Computer Software].
Nashville, TN: Vanderbilt University and Philadelphia, PA: Childrens Hospital of Philadelphia.
Available from https://github.com/sburns/PyCap. doi:10.5281/zenodo.9917
Available from https://github.com/redcap-tools/PyCap. doi:10.5281/zenodo.9917


Contents:
Expand Down
4 changes: 2 additions & 2 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ def find_version(*file_parts):
maintainer_email="scott.s.burns@gmail.com",
description="""PyCap: Python interface to REDCap""",
license="MIT",
url="http://sburns.github.com/PyCap",
url="https://github.com/redcap-tools/PyCap",
version=find_version("redcap", "__init__.py"),
download_url="http://sburns.github.com/PyCap",
download_url="https://github.com/redcap-tools/PyCap",
long_description=long_desc,
long_description_content_type="text/x-rst",
packages=["redcap"],
Expand Down