<h1 align="center">CPL - Common python library</h1>

<!-- Summary -->
<p align="center">
  <!-- <img src="" alt="cpl-logo" width="120px" height="120px"/> -->
  <br>
  <i>
  CPL is a development platform for python server applications
  <br>using Python.</i>
  <br>
</p>

## Table of Contents
<!-- TABLE OF CONTENTS -->
<ol>
   <li>
     <a href="#getting-started">Getting Started</a>
     <ul>
       <li><a href="#prerequisites">Prerequisites</a></li>
       <li><a href="#installation">Installation</a></li>
     </ul>
   </li>
   <li><a href="#roadmap">Roadmap</a></li>
   <li><a href="#contributing">Contributing</a></li>
   <li><a href="#license">License</a></li>
   <li><a href="#contact">Contact</a></li>
</ol>


<!-- GETTING STARTED -->
## Getting Started

[Get started with CPL][quickstart].

### Prerequisites

- Install [python] which includes [Pip installs packages][pip]

### Installation

Install the CPL package
```sh
pip install sh_cpl --extra-index-url https://pip.sh-edraft.de
```

Install the CPL CLI
```sh
pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
```

Create workspace:
```sh
cpl new <console|library> <PROJECT NAME>
```

Run the application:
```sh
cd <PROJECT NAME>
cpl start
```


<!-- ROADMAP -->
## Roadmap

See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/issues) for a list of proposed features (and known issues).



<!-- CONTRIBUTING -->
## Contributing

### Contributing Guidelines

Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more.

### Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing].



<!-- LICENSE -->
## License

Distributed under the MIT License. See [LICENSE] for more information.



<!-- CONTACT -->
## Contact

Sven Heidemann - sven.heidemann@sh-edraft.de

Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib)

<!-- External LINKS -->
[pip_url]: https://pip.sh-edraft.de
[python]: https://www.python.org/
[pip]: https://pypi.org/project/pip/

<!-- Internal LINKS -->
[project]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib
[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/quickstart
[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/wiki/contributing
[license]: LICENSE
