earaujoassis / deployment

Git-based deployment scripts

Deployment

Git-based deployment scripts

Deploymnet is a collection of git-based deployment scripts, written in Python, initially used for one small and simple project, but turned into a complex and rich solution for deploying small and personal projects of mine. It is not intended to be used in large, complex systems — ultimately, it's been used for small contexts and scenarios. It is inspired by Heroku's deployment solutions and its CLI.

Installing & Running

This is a Python pip package, so you're able to pip install it in your work environment. Basically, it will make available a ploy binary, which should be helpful to setup new projects and deploy it.

$ pip install --user https://github.com/earaujoassis/deployment/archive/0.1.7.zip

Once the package is installed, you may run ploy init in order to setup a project. It will check if the project has a .git setup and create the necessary git-hooks and deployment scripts in the working directory. The ploy setup will attempt to connect to the remote server and create the necessary information. If something is wrong or any necessary information is needed, it will ask for it or raise any error. Once the init and setup steps are successfully completed, you may run git push deployment master in order to deploy the current project to the remote upstream (ploy setup will have created the necessary upstream for it).

If you need any help, please run ploy --help.

Developing

In order to create a sandbox (virtual environment) and install it for development or testing, you may run the following commands:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip install .
$ ploy --help

The ploy binary will be available in the current shell session.

Issues

Please take a look at /issues

License

MIT License © Ewerton Carlos Assis