Skip to main content

Aurora is an MVC web framework for creating RESTFUL CRUD applications quickly and simply

Project description

Welcome to Aurora

Aurora is an MVC web framework for creating CRUD applications quickly and simply.

It based on REST architecture. In another word it is a RESTFUL web framework.

Aurora mostly is written in Python, and partially have used Flask.

Installation

You can install Aurora by running:

$ pip install aurora-mvc

Usage

Get Started

To get started with Aurora simply do the following steps:

  1. Create the root app (project) directory:
$ mkdir my_app

Here my_app is a variable name. Change it to anything of your choice at any time you want.

  1. Install a python virtual environment in the same path that the project directory exists:
$ python -m venv venv
  1. Activate the virtual environment:

Linux / Mac:

$ . venv/bin/activate

Windows:

$ venv\scripts\activate
  1. Navigate to the project directory:
(venv) cd my_app

Notice that the project directory must be empty, otherwise you will get an error on the next step.

  1. Initialize the root app with Aurora via python shell:
(venv) python
>>> from aurora import init_app
>>> init_app.start()

Congratulations! You successfully initialized the root app. Now you are ready to get started with Aurora.

  1. To start the root app run the following command:
(venv) python app.py

Next Steps

Documentation: Aurora Docs

Changelog: Aurora Changes

Issues: Aurora Bug Tracker

Source: Aurora GitHub Repo

PyPI: Aurora PyPI Page

Dependencies

Packages:

Database APIs:

  • sqlite3 -- If you are using SQLite Database. Included in the standard python library
  • psycopg2 -- If you are using Postgres Database.
  • mysql.connector -- If you are using MySQL Database.

About The Author

Hello World!

I'm Hemin Satya, a freelance programmer. This is the first open-source project I have ever done. Aurora framework is currently on a beta version, and I'm trying my best to make it something magnificent. I hope you like it.

If you saw any bugs or mistakes, please let me know. I'll do my best to solve them or at least reduce them asap.

Please let me know your precious comments, observations, and suggestions. (GitHub) (Twitter)

Thank you all.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aurora-mvc-0.7.6.tar.gz (109.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aurora_mvc-0.7.6-py3-none-any.whl (112.9 kB view details)

Uploaded Python 3

File details

Details for the file aurora-mvc-0.7.6.tar.gz.

File metadata

  • Download URL: aurora-mvc-0.7.6.tar.gz
  • Upload date:
  • Size: 109.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.0 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for aurora-mvc-0.7.6.tar.gz
Algorithm Hash digest
SHA256 1512a3d7dd9abbd87d1e47509ef15f953eb8b89382a639f5885a1875fb80958d
MD5 c3a58b6e58a505db3377dfaa6f1be045
BLAKE2b-256 470e89545351f8c9a55849a7d444324ac67406b199c5ff38a4b8207e9b375b05

See more details on using hashes here.

File details

Details for the file aurora_mvc-0.7.6-py3-none-any.whl.

File metadata

  • Download URL: aurora_mvc-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 112.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.0 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for aurora_mvc-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 af6219f10e1a177f083929b5729c9d4a86d6cac88294332682c39d251bcc20b2
MD5 99389f6f21a45b2801531770fa151589
BLAKE2b-256 47afbcf302217e5d9f1b04e16f1ffef35eae7a3036cca30884bd021ab84491d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page