https://github.com/girardinsamuel/masonite-backups

Easily backup (database and assets) your Masonite projects
https://github.com/girardinsamuel/masonite-backups

Last synced: about 1 month ago
JSON representation

Easily backup (database and assets) your Masonite projects

• Host: GitHub
• URL: https://github.com/girardinsamuel/masonite-backups
• Owner: girardinsamuel
• License: mit
• Created: 2021-07-26T20:15:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-16T21:01:48.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T15:34:29.088Z (3 months ago)
• Language: Python
• Size: 29.3 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





  

    

  

  

  

  

  

  

  

  



## Introduction

Easily backup (database and assets) your Masonite apps

## Features

- Database (PostgreSQL, SQLite, MySQL) backup

- Assets backup

- Backup upload to defined storage (local, S3...)

- Others to come...

## Official Masonite Documentation

New to Masonite ? Please first read the [Official Documentation](https://docs.masoniteproject.com/).

Masonite strives to have extremely comprehensive documentation 😃. It would be wise to go through the tutorials there.

If you find any discrepencies or anything that doesn't make sense, be sure to comment directly on the documentation to start a discussion!

Also be sure to join the [Slack channel](http://slack.masoniteproject.com/)!

## Installation

```bash

pip install masonite-backups

```

## Configuration

Add BackupsProvider to your project in `config/providers.py`:

```python

# config/providers.py

# ...

from masonite.backups import BackupsProvider

# ...

PROVIDERS = [

    # ...

    # Third Party Providers

    BackupsProvider,

    # ...

]

```

Then install OR publish the required package files (configuration, views ...):

```bash

python craft backups:install

```

OR (depending on your preferences)

```bash

python craft publish BackupsProvider

```

Specify sources, destination, name at minimum.

## Usage

To make a backup of all assets and databases defined in config file run this command:

```bash

python craft backups:run

```

To make a backup of databases only:

```bash

python craft backups:run --only-db

```

To make a backup of assets only:

```bash

python craft backups:run --only-assets

```

## Contributing

Please read the [Contributing Documentation](CONTRIBUTING.md) here.

## Maintainers

- [Samuel Girardin](https://www.github.com/girardinsamuel)

## License

Masonite Backups is open-sourced software licensed under the [MIT license](LICENSE).