eoepca-oidc 0.0.1

Open ID Connect python library developed by the EOEPCA team

PyLibraryTemplate

Template for developing an EOEPCA Library
Explore the docs . Report Bug · Request Feature

Setup this template!

• Generate a new token in PyPi account exclusively for this library

• setup the following variables (in travis webpage, for this project) to ensure travis automated CI works (https://travis-ci.com/github/EOEPCA//settings):

  1. GH_REPOS_NAME (this repo's name)
  2. GH_USER_NAME (GitHub name for the responsible of this module)
  3. GH_USER_EMAIL (GitHub email for the responsible of this module)
  4. TOKEN_PYPI (Token you created in a previous step)

• Un-comment the "notifications" segment in .travis.yml, and input the correct data for slack and/or emails you want to notify

• Edit readme to fit your repository, deleting this part!

Table of Contents

• Setup this template!
• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Testing
• Documentation & Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• Python
• PyTest
• YAML
• Travis CI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Python 3
• Pip

Installation

Just download the library using pip

pip install PyLibraryTemplate

Testing

pytest PyLibraryTemplate/tests

Documentation & Usage

The component documentation can be found at https://eoepca.github.io/um-pylibrary-template/.

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. 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 Apache-2.0 License. See LICENSE for more information.

Contact

EOEPCA mailbox

Project Link: https://github.com/EOEPCA/um-pylibrary-template

Acknowledgements

• README.md is based on this template by Othneil Drew.