UMLS API Tool

Tools to simplify retrieving from the UMLS API.

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About the Project

Tools to simplify retrieving from the UMLS API.

In particular, this library is designed to handle: * Repeated authentication calls (once you have your [api key](https://documentation.uts.nlm.nih.gov/rest/authentication.html), the Authenticator will handle everything else)

Getting Started

Prerequisites

• Python 3.8+ (probably works in earlier versions)
• Create UMLS account (see https://uts.nlm.nih.gov/uts/umls/home)
• Obtain UMLS API KEY (once signed in, see https://uts.nlm.nih.gov/uts/profile)
• pip install git+https://github.com/dcronkite/umls_api_tool.git * Or, git pull; cd umls_api_tool; pip install .

Usage

See the examples in the examples folder to see how to use the code.

Use the [UMLS REST API Home Page](https://documentation.uts.nlm.nih.gov/rest/home.html) for complete API documentation.

Versions

Uses SEMVER.

See https://github.com/dcronkite/umls_api_tool/releases.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

See LICENSE or https://dcronkite.mit-license.org for more information.

Contact

Please use the issue tracker.

Acknowledgements