https://github.com/dedupeio/dedupeio-web-api-docs
Dedupe.io web API allows for matching and training against projects using a standard RESTful framework.
https://github.com/dedupeio/dedupeio-web-api-docs
Last synced: 3 months ago
JSON representation
Dedupe.io web API allows for matching and training against projects using a standard RESTful framework.
- Host: GitHub
- URL: https://github.com/dedupeio/dedupeio-web-api-docs
- Owner: dedupeio
- Created: 2017-05-19T15:26:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-26T19:52:55.000Z (about 6 years ago)
- Last Synced: 2025-04-15T11:54:55.769Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 104 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dedupe.io web API documentation
Documentation for Dedupe.io web API: https://apidocs.dedupe.io
Part of the [Dedupe.io](https://dedupe.io/) cloud service and open source toolset for de-duplicating and finding fuzzy matches in your data.
## Set-up
Read the Docs suggests using Sphinx, a tool to facilitate the generation of nice-looking documentation. Before you install Sphinx, you may want to set-up a virtualized development environment: learn [how to set up virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/).
Then, run the following in your terminal:
```bash
mkvirtualenv dedupeio-web-api-doc
git clone git@github.com:dedupeio/dedupeio-web-api-doc.git
cd dedupeio-web-api-doc
pip install -r requirements.txt
```
Afterwards, whenever you want to use this virtual environment, run `workon web-api-documentation`.
## Contribute
You can learn about the process of Sphinx and document creation on the [Read the Docs site](http://docs.readthedocs.io/en/latest/getting_started.html).
Ready to dive in? Edit the `rst` files in the `docs` directory. Then, generate the html by running the Makefile:
```bash
cd docs
make html
```
Then, view your code in a browser:
```bash
open _build/html/index.html
```
## Team
* Forest Gregg, DataMade
* Regina Compton, DataMade
* Derek Eder, DataMade