https://github.com/zanderlewis/sitepy
A simple, batteries-included web framework
https://github.com/zanderlewis/sitepy
Last synced: about 1 year ago
JSON representation
A simple, batteries-included web framework
- Host: GitHub
- URL: https://github.com/zanderlewis/sitepy
- Owner: zanderlewis
- License: other
- Created: 2024-04-17T17:39:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T15:32:07.000Z (about 2 years ago)
- Last Synced: 2024-05-20T22:06:05.000Z (about 2 years ago)
- Language: Python
- Homepage: https://pypi.org/project/sitepy/
- Size: 107 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sitepy
A simple web framework for Python.
[](https://star-history.com/#WolfTheDeveloper/sitepy&Date)
## Installation
You can install sitepy with pip:
```sh
pip install sitepy
```
## Usage
Here's a basic example of a sitepy application:
```python
from sitepy import SitePy
app = SitePy()
@app.route("/", methods=['GET', 'POST'])
def index():
return "Hello, world!"
if __name__ == "__main__":
app.run()
```
Render Templates:
```python
from sitepy import SitePy
app = SitePy()
@app.route("/", methods=['GET', 'POST'])
def index():
someVar = "Hello, World!"
return app.render_template("index.html", someVar)
if __name__ == "__main__":
app.run()
```
This will start a server on localhost:8080 and respond with "Hello, world!" to GET and POST requests at the root URL.
## Features
- Simple routing: Use decorators to define routes.
- Middleware support: Use app.use to add middleware functions.
- Static file serving: Files in the static directory are served at /static.
- Template serving: Files in the templates/ directory will act as a template.
- Built in features for checking profanity, using Postgres, Mysql, and SQLite, using the openai library, and more.
## Built-Ins
To learn how to use the built-in features, check out the [examples.](examples/)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[Apache](sitepy/LICENSE)