Skip to content
Permalink
Browse files

Improve documentation.

  • Loading branch information...
DavidLemayian committed Nov 16, 2017
1 parent b7d5ea7 commit b3b37b40d251c6a22abde5ba1c045e55a8ed36cd
Showing with 206 additions and 10 deletions.
  1. +18 −0 .github/ISSUE_TEMPLATE.md
  2. +25 −0 .github/PULL_REQUEST_TEMPLATE.md
  3. +114 −0 CONTRIBUTING.md
  4. +46 −9 README.md
  5. +3 −1 setup.py
@@ -0,0 +1,18 @@
## Description
A clear and concise description of what the issue is about.

## Screenshots


## Files
A list of relevant files for this issue. This will help people navigate the project and offer some clues of where to start.

## To Reproduce
If this issue is describing a bug, include some steps to reproduce the behavior.

## Tasks
Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at.
- [ ] Task 1
- [ ] Task 2
- [ ] Task 3

@@ -0,0 +1,25 @@
## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update


## Screenshots


## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
@@ -0,0 +1,114 @@
# Introduction

You are here to help on HealthTools.API? Awesome, feel welcome and read the following
sections in order to know what and how to work on something. If you get stuck
at any point you can create a ticket on
[GitHub](https://github.com/CodeForAfricaLabs/HealthTools.API/issues).

All members of our community are expected to follow our
[Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct). Please make
sure you are welcoming and friendly in all of our spaces.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue, assessing
changes, and helping you finalize your pull requests.

## Types of Contributions

You can contribute in many ways. For example, you might:
* Add documentation and "how-to" articles in the [README](README.md) or the wiki
* Suggest Enhancements
* Fix issues
* Submit Bug reports

#### Bug Reports
*If you find a security vulnerability, **DO NOT** open an issue. Email
[security@codeforafrica.org](mailto:security@codeforafrica.org) instead.*

If you're reporting a bug, please include:
* Your operating system name and version
* Any details about your local setup that might be helpful in troubleshooting.
* If you can, provide detailed steps to reproduce the bug.
* If you don't have steps to reproduce the bug, just note your observations in
as much detail as you can. Questions to start a discussion about the issue
are welcome.

To ease the process of reporting bugs and issues, consider using our
[issue template](https://github.com/CodeForAfricaLabs/HealthTools.API/blob/master/.github/ISSUE_TEMPLATE.md)
and don't forget to add an appropriate
[label](https://help.github.com/articles/creating-a-label/) to the issue.

#### Writing Documentation
Did you find a typo? Do you think that something should be clarified? Go ahead
and suggest a documentation patch. HealthTools.API could always use more documentation,
whether as part of the official docs, in docstrings, or even on the web in blog
posts, wiki, articles, and such.

#### Fixing Issues
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to
whoever wants to implement it.

#### Suggesting Enhancements

Before creating enhancement suggestions, please check the issues list as you
might find out that you don't need to create one. When you are creating an
enhancement suggestion fill out the
[issue template](https://github.com/CodeForAfricaLabs/HealthTools.API/blob/master/.github/ISSUE_TEMPLATE.md)
and [label](https://help.github.com/articles/creating-a-label/) the issue as a
new feature.

## Your first contribution

Unsure where to begin contributing to HealthTools.API? You can start by looking through
these `beginner` and `help-wanted` issues:

* `Beginner issues` - issues which should only require a few lines of code, and a
test or two.
* `Help wanted issues` - issues which should be a bit more involved than beginner
issues.

Once your changes and tests are ready to submit for review:

1. Test your changes

Run the tests if you have any and at the bare minimum, test your changes
manually.

2. Rebase your changes

Update your local repository with the most recent code from the main HealthTools.API
repository, and rebase your branch on top of the latest develop branch.

3. Submit a pull request

Push your local changes to your forked copy of the repository and submit a
pull request. In the pull request, choose a title which sums up the changes
that you have made, and in the body provide more details about what your
changes do. Also mention the number of the issue where discussion has taken
place. Preferably use our
[PR template](https://github.com/CodeForAfricaLabs/HealthTools.API/blob/master/PULL_REQUEST_TEMPLATE.md).

Then sit back and wait. There will probably be discussion about the pull
request and, if any changes are needed, we would love to work with you to
get your pull request merged into HealthTools.API.

## Code Style

Please adhere to the [PEP8](https://www.python.org/dev/peps/pep-0008/) Coding
conventions for the Python language. This style guide evolves over time as
additional conventions are identified and past conventions are rendered obsolete
by changes in the language itself. Ensure to keep updated.

## Ground Rules
The goal is to maintain a diverse community that's pleasant for everyone.
That's why we would greatly appreciate it if everyone contributing to and
interacting with the community also followed this
[Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct).
The [Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct) covers our
behavior as members of the community, in any forum, mailing list, wiki, website,
Internet relay chat (IRC), public meeting or private correspondence.



Please see [contribution-guide.org](http://www.contribution-guide.org) for details on what we expect from contributors. Thanks!
@@ -1,23 +1,40 @@
# HealthTools.API

_The HealthTools API. Providing actionable health information._

The HealthTools API provides a simple wrapper around Elasticsearch data being made available through the [HealthTools Scrapers](https://github.com/CodeForAfrica-SCRAPERS/healthtools_ke).

Through the API you can access data that we've scraped from:

1. Doctors: http://medicalboard.co.ke/online-services/retention/
2. Foreign Doctors: http://medicalboard.co.ke/online-services/foreign-doctors-license-register
3. Clinical Officers: http://clinicalofficerscouncil.org/online-services/retention/
4. Health Facilities: http://kmhfl.health.go.ke
5. NHIF accredited outpatient facilities for civil servants: http://www.nhif.or.ke/healthinsurance/medicalFacilities
6. NHIF accredited inpatient facilities: http://www.nhif.or.ke/healthinsurance/inpatientServices
7. NHIF accredited outpatient facilities: http://www.nhif.or.ke/healthinsurance/outpatientServices


## Usage

?
To use the HealthTools.API, checkout our API docs here:

https://healthtools.codeforafrica.org


## Development

Clone the repo from github `$ git clone https://github.com/CodeForAfricaLabs/HealthTools.API.git`
HealthTools.API is a simple [Flask app](http://flask.pocoo.org) that you can set up by following these steps:

Change directory into package `$ cd HealthTools.KE-api`
```
$ git clone https://github.com/CodeForAfricaLabs/HealthTools.API.git
$ cd HealthTools.API
$ python setup.py develop
```

Install the dependencies by running `$ pip install -r requirements.txt`
Once done, you can run the Flask app server:

?
```
$ python healthtools/manage.py runserver
```


### Tests
@@ -28,10 +45,30 @@ Use nosetests to run tests (with stdout) like this:
## Contributing
?
If you'd like to contribute to HealthTools.API, check out the [CONTRIBUTING.md](CONTRIBUTING.md) file on how to get started.
---
## License
?
MIT License
Copyright (c) 2017 Code for Africa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -6,10 +6,12 @@
keywords='healthtools',
author='Code for Africa',
author_email='support@codeforafrica.org',
url='https://healthtools.readthedocs.io/',
url='https://github.com/CodeForAfricaLabs/HealthTools.API',
license='MIT',
packages=find_packages(exclude=['ez_setup', 'examples', 'test']),
include_package_data=True,

# Pull these from requirements.txt
install_requires=[
'flask',
'requests',

0 comments on commit b3b37b4

Please sign in to comment.
You can’t perform that action at this time.