Metadata-Version: 2.1
Name: Silence
Version: 2.2.0
Summary: An educational API+Web framework.
Home-page: http://github.com/DEAL-US/Silence
Author: Agustín Borrego
Author-email: borrego@us.es
Maintainer: Miguel Bermudo
Maintainer-email: mbermudo@us.es
License: MIT
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama~=0.4.4
Requires-Dist: cryptography~=36.0.2
Requires-Dist: Flask-Cors==3.0.10
Requires-Dist: Flask==2.0.3
Requires-Dist: itsdangerous~=2.0.1
Requires-Dist: PyMySQL~=1.0.2
Requires-Dist: pypika==0.48.9
Requires-Dist: requests~=2.27.1
Requires-Dist: Werkzeug~=2.0.3

<p align="center"><img width="100%" src="img/logo.svg" alt="Silence logo"></p>
<p align="center">
<a href="https://github.com/DEAL-US/Silence/actions/workflows/ci_test.yml"><img src="https://github.com/DEAL-US/Silence/actions/workflows/ci_test.yml/badge.svg"></a> 
<a href="https://pypi.org/project/Silence/"><img src="https://img.shields.io/pypi/v/Silence.svg?label=Version"></a>
<a href="https://pepy.tech/project/silence"><img src="https://static.pepy.tech/personalized-badge/silence?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads"></a>&nbsp;<img src="https://img.shields.io/badge/Python-3.8%20%E2%80%94%203.12-blue"></p>

<hr>

Silence is a framework that allows for a rapid deployment of a RESTful API and a Web application around a relational database. Silence revolves around the concept of projects, which contain everything needed to deploy the previously mentioned elements and can be moved and/or shared between computers or systems with ease.

Check out [**Silence's wiki page**](https://github.com/DEAL-US/Silence/wiki) to see how to get started and for detailed documentation.

Silence has been built by the [**DEAL research group**](https://deal.us.es/) as an educational and teaching tool for its use in several courses of the Degree in Computer Science at the University of Seville.

![SVG animation showing the process of creating a new project, configuring it, creating the database and API endpoints, and running it](img/setup.svg)

# Documentation and changelog
Please see [**Silence's wiki**](https://github.com/DEAL-US/Silence/wiki) and [**CHANGELOG.md**](CHANGELOG.md)

# Citing Silence
If you find Silence useful for your ongoing research work, please consider citing it as:

```bibtex
@article{borrego2022silence,
    author = {Borrego, Agust{\'i}n and Bermudo, Miguel and Sola, Fernando and Ayala, Daniel and Hern{\'a}ndez, Inma and Ruiz, David},
    title = {{Silence — A web framework for an agile generation of RESTful APIs}},
    journal = {SoftwareX},
    volume = {20},
    pages = {101260},
    year = {2022},
    doi = {10.1016/j.softx.2022.101260},
    url = {https://www.sciencedirect.com/science/article/pii/S2352711022001789}
}
```

# Contributions
All contributions are welcome provided that they follow our [Code of Conduct](CODE_OF_CONDUCT.md).

We keep a [TO-DO](TO-DO.md) with ideas to implement in the future. Feel free to open an issue or send us an email if you need clarifications with any of its items.
