weblodge 0.1.4

No project description provided

WebLodge

WebLodge is a command line aiming to provide anyone with deployment and cloud management capabilities.

Prerequisite

• Install the command line with pip install weblodge.
• A Python Flask application.
• A requirements.txt with the application dependencies.
• Have an Azure account.

Note: By default, WebLodge uses Free Azure services and lets the user specify non-free configurations.

Deploying an application

The simple way to deploy your local application is by running the command line weblodge deploy --build in your application directory.

In that case, WebLodge will assume that your application entry point is named app.py and your dependencies file is requirements.txt.

Behind the scene, WebLodge build then deploy your application.

Application structure

WebLodge is sensible to the application structure. Applications must follow the pre-defined pattern or specify custom values.

Here is an example of the standard pattern deployable without configuration:

$ cat app.py  # The application filename entry point.
from flask import Flask

app = Flask(__name__)  # The Flask application.

@app.route("/")
def hello_world():
    return "<p>Hello, World!</p>"

It can be deployed with weblodge deploy --build.

Here is a non-standard example:

$ cat main.py  # The application filename entry point.
from flask import Flask

my_app = Flask(__name__)  # The Flask application.

@app.route("/")
def hello_world():
    return "<p>Hello, World!</p>"

To be able to deploy the application, you must first build it and specify:

• The entry point file: main.py.
• The Flask application: my_app.

# Build the application.
weblodge build --entry-point main.py --app my_app
# Deploy the application.
weblodge deploy

Build

The build operation collects and prepares the application for deployment on a specific platform.

The build operation can handle the following options:

Option name	Description	Default value
src	Folder containing application sources.	'.'
dist	Folder containing the application built.	'dist'
entry-point	The application file to be executed with python.	'app.py'
app	The Flask application object in the entry-point file.	'app'
requirements	The requirements.txt file path of the application. This file will be put at the root of the application.	'requirements.txt'

Note: Here, the platform is implicitly Azure App Service.

Example:

# Build the local application.
weblodge build

# Build the application in the 'myapp' folder.
weblodge build --src myapp

Deploy

The deploy operation creates the necessary infrastructure and uploads the build package - i.e. your code - on the infrastructure.

Option name	Description	Default value
app-name	The unique name of the application on the Internet. It will be included in the application URL.	<randomly generated>
sku	The application computational power.	'F1'
location	The physical application location.	'northeurope'
environment	The environment of your application.	'development'
dist	Folder containing the application built.	'dist'

Example:

# Deploy the local application.
weblodge deploy

# Deploy the local application with a custom name.
weblodge deploy --app-name myapp

Delete

The delete operation deletes the infrastructure deployed but keeps the build.

Option name	Description	Default value
app-name	The name of the application to be deleted.	<my-app>
yes	Do not prompt a validation message before deletion.	'false'

Example:

# Delete the application previously deployed.
weblodge delete

Logs

The logs operation streams your application logs. Because it is a stream, logs are truncated.

Option name	Description	Default value
app-name	The name of the application.	<my-app>

Example:

# Print logs of the application previously created.
weblodge logs

Configuration file: .weblodge.json

At the end of a deployment, WebLodge creates a file named .weblodge.json by default. This file contains the previous configuration, enabling WebLodge to update your application with the same parameters. This file can be version-controlled and used in your Continuous Deployment.

You can change the name of this file with the --config-filename option.

Example:

weblodge build --config-filename myconfigfile.json

Manage your WebLodge-deployed application

Managing and updating is a daily infrastructure task with no visible value for the end user. WebLodge uses an Azure Platform as a Service resource named Azure App Service to keep your infrastructure as secure, up-to-date and reliable as possible. This tool keeps your infrastructure at the state-of-the-art, allowing you to focus on your application's functionality.

But whatever your infrastructure tools are, it's your responsibility to keep your application secure and your dependencies up-to-date.

Feedbacks

Feel free to create issues with bugs, ideas and any constructive feedback.

MIT License

Copyright (c) 2023 Vuillemot Florian

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.