From d5352ca05353a5645f6df2d1ca8159a7e6195d6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Mar=C3=ADa?= Date: Wed, 22 Mar 2023 12:46:05 +0100 Subject: [PATCH] first commit --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2222d38 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# WOD API - Words Of Domain API + +WOD API is a quick and simple API to get words of a domain name. + +## Key features + +* Purely Python +* It's an API with only 1 endpoint +* Needs flask library +* Needs wordsegment library + +## Requirements + +WOD API requires **flask** and **wordsegment** Python libraries: + +* pip install flask +* pip install wordsegment + +## Usage + +- Run: python .\wodapi.py +- Then, a server is deploy on http://127.0.0.1:5000 +- Use GET in endpoing domain: http://127.0.0.1:5000/domain/hereyourdomainname + +## Documentation + +This is the README file + +## Authors + + * Bichi - José Mª Ávila + * Antonio Villamarin + +## License + +This is a NIDOMA development + +## Links + +- https://grantjenks.com/docs/wordsegment/ +- https://pypi.org/project/wordsegment/ +- https://blog.stoplight.io/python-rest-api \ No newline at end of file