Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milochen0418/pyneweb
Pyneweb is a powerful Python web boilerplate project that gives developers a head start on building web applications with Python and Pynecone.
https://github.com/milochen0418/pyneweb
Last synced: 9 days ago
JSON representation
Pyneweb is a powerful Python web boilerplate project that gives developers a head start on building web applications with Python and Pynecone.
- Host: GitHub
- URL: https://github.com/milochen0418/pyneweb
- Owner: milochen0418
- License: mit
- Created: 2023-05-11T08:38:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-05T15:50:20.000Z (over 1 year ago)
- Last Synced: 2024-04-23T22:08:33.985Z (7 months ago)
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
pyneweb.
Pyneweb is a Python web boilerplate project designed to provide a solid foundation for building web applications with Python and Flet. The project comes pre-configured with a range of tools and features to make it easy for developers to get started building their applications, without the need to spend time setting up infrastructure or configuring tools.
## 1. Installation
To use Pyneweb, you need to have the following installed:
- Latest version of Pynecone
- Python 3.7+
If you don't have Pynecone installed, installing Pyneweb automatically installs it for you. You can install Pyneweb using the following command:
```
$ pip install pyneweb
```
## 2. Application Setup
After installing Pyneweb, you can test if it's working properly by running the following command:
```
$ pyneweb-init
```
If the package was installed correctly, a directory named ```logic``` along with a file called ```config.yml``` will be generated inside the root directory.
The ```logic``` directory will contain four files:
1. ```__init__.py```
2. ```script.py```
3. ```utilities.py```
## 3. Current Algorithm Functions
This algorithm is a script that loads and processes data from a YAML file ```config.yml``` that contains navigation information for a web application. The script then updates and creates various files and directories necessary for the application to function.
Here is a summary of what the algorithm does (v0.1.0):
1. Import necessary libraries and functions
2. Define a dictionary variable to hold route keys
3. Define several functions to perform various tasks:
1. open_yaml_script(): Loads data from the "config.yml" file.
2. check_pages_directory_script(): Checks if a "routes" directory exists and creates one if not.
3. update_pages_directory_script(docs: dict): Loops over the files in the "routes" directory and deletes any files that are not listed in the navigation information.
4. handle_navigation_routing_script(docs: dict): Loops over the navigation information and writes route strings to a temporary file.
5. set_application_routing_script(docs: dict): Reads the temporary file created in the previous step, creates a route.py file with the appropriate routes, and deletes the temporary file.
6. set_default_methods_script(docs: dict): Loops over the navigation information and creates default pages for each page listed, and creates a route.pickle file with information about the modules used in the application.
7. map_yaml(yaml_file_path, output_file_path): Reads a YAML file and writes its contents to a Python file with a specified filename. (soon)
8. script(app): Main function that calls the other functions to process the data and set up the application.
Overall, the script is part of a larger application development process that involves reading and processing data from a YAML file, creating and updating various files and directories, and setting up routing information for a web application.
## Contributing
Contributions are highly encouraged and welcomed.
## License
Pyneweb is open-source and licensed under the [MIT License](LICENSE).