https://github.com/puria/python
Template for python :snake: small packages
https://github.com/puria/python
Last synced: 3 months ago
JSON representation
Template for python :snake: small packages
- Host: GitHub
- URL: https://github.com/puria/python
- Owner: puria
- License: apache-2.0
- Created: 2020-01-02T17:28:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-13T09:43:36.000Z (about 5 years ago)
- Last Synced: 2025-01-22T11:47:43.868Z (5 months ago)
- Language: Python
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
{project_name}
{tagline}
💾 Install
•
🎮 Quick start
•
🐋 Docker
•
🐝 API
•
🔧 Configuration
•
📋 Testing
•
🐛 Troubleshooting & debugging
•
😍 Acknowledgements
•
🌐 Links
•
👤 Contributing
•
💼 License
Abstract description like: 🚧 Zenroom is a software in **ALPHA stage** and are part of the [DECODE project](https://decodeproject.eu) about data-ownership and [technological sovereignty](https://www.youtube.com/watch?v=RvBRbwBm_nQ). Our effort is that of improving people's awareness of how their data is processed by algorithms, as well facilitate the work of developers to create along [privacy by design principles](https://decodeproject.eu/publications/privacy-design-strategies-decode-architecture) using algorithms that can be deployed in any situation without any change.
🚩 Table of Contents (click to expand)
* [Install](#-install)
* [Quick start](#-quick-start)
* [Docker](#-docker)
* [API](#-api)
* [Configuration](#-configuration)
* [Testing](#-testing)
* [Troubleshooting & debugging](#-troubleshooting--debugging)
* [Acknowledgements](#-acknowledgements)
* [Links](#-links)
* [Contributing](#-contributing)
* [License](#-license)
***
## 💾 Install
```pip install {project_name}```
***
## 🎮 Quick start
To start using {project_name} just (fill with real documentation)
***
## 🐋 Docker
```bash
docker build -t {project_name} .
docker run --rm -it {project_name}
```
***
## 🐝 API
***
## 🔧 Configuration
***
## 📋 Testing
***
## 🐛 Troubleshooting & debugging
***
## 😍 Acknowledgements
{copyright}
Designed, written and maintained by Puria Nafisi Azizi.
Special thanks to Mr. W. White for his special contributions.
***
## 🌐 Links
https://www.somelink.io/
https://dyne.org/
***
## 👤 Contributing
1. 🔀 [FORK IT](../../fork)
2. Create your feature branch `git checkout -b feature/branch`
3. Commit your changes `git commit -am 'Add some foobar'`
4. Push to the branch `git push origin feature/branch`
5. Create a new Pull Request
6. 🙏 Thank you
***
## 💼 License
{project_name} - {tagline}
{copyright}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.