Skip to main content

Class-based Fabric scripts via a Python metaprogramming hack

Project description

#### Introduction

This is a hack to enable the definition of Fabric tasks as methods in a class instead of just as module level functions. This class-based approach provides the benefits of inheritance and method overriding.

We had several Fabric scripts which violated DRY. Class-based Fabric script can solve this issue.

#### Example usage:

```python
from fabriclassed import initialize
from fabriclassed.base import BaseFabric, DjangoFabric, VirtualenvFabric
from fabric import api as fab

class Fabric(BaseFabric):
remote_project_path = '/local/path/to/my_project'
local_project_path = '/remote/path/to/my_project'

def task(self):
'''My website task'''
fab.local('echo "Hello world"')

__all__ = initialize(Fabric(), __name__)
```

Running fab -l gives:

```
$ fab -l
Available commands:

del_pyc Remove all .pyc files inside in fabfile and child direc...
search Search string amoung source code inside directories fro...
task My website task
```

Running fab task gives:

```
$ fab task
[localhost] local: echo "Hello world"
Hello world

Done.
```

#### Extended usage with Django under Virtualenv:

DjangoFabric and VirtualenvFabric classes contains various of tools to work with Django in Virtualenv environment. You can use both of these toos together or separately, as you like.

Example of Fabric class with a bunch of properies:

```python
from fabriclassed import initialize
from fabriclassed.base import BaseFabric, DjangoFabric, VirtualenvFabric
from fabric.api import lcd, local

class Fabric(BaseFabric, DjangoFabric, VirtualenvFabric):
search_dirs = []

hosts = ['website.com']
remote_project_path = '/local/path/to/my_project'
local_project_path = '/remote/path/to/my_project'

# django settings
managefile_path = './manage.py'
test_default_app = 'name_of_my_main_django_application'
test_settings = 'settings_test_special_file'
shell_plus = True
devserver_port = 8000

# virtualenv settings
use_virtualenv = True
virtualenv_dir = 'env'
patched_applications = [
# list of virtualenv patched applications
]
diff_dir = 'my_relative_to_project_diffs_dir'
applications_dir = 'my_relative_to_project_apps_dir'

__all__ = initialize(Fabric(), __name__)
```

Running fab -l gives:

```
Available commands:

del_pyc Remove all .pyc files inside in fabfile and child direc...
dev Run Django's dev server
diff_dump Walk over map of patched applications and make diff fil...
patch Walk over 'diffs' directory and patch every application
search Search string amoung source code inside directories fro...
sh Run Django's standart shell or shell from django_extent...
symlink Create symlink from 'apps' dir to the site-packages or ...
test Run Django's tests. Argument can be application name, n...
virtualenv Context manager for running command in virtualenv envir...
```

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

fabriclassed-0.3.4.tar.gz (4.9 kB view details)

Uploaded Source

File details

Details for the file fabriclassed-0.3.4.tar.gz.

File metadata

File hashes

Hashes for fabriclassed-0.3.4.tar.gz
Algorithm Hash digest
SHA256 5d8fbbd6d95b0e0137f85ed6e96013ec81198996ab5b43d8d90c7440aac16304
MD5 6d10cd6af48f5bcb5ea1fb95e51a11d6
BLAKE2b-256 db602c260bc171898f50e5bf2f9b463f1aa762b6283c3adba93bf24afde0837c

See more details on using hashes here.

Supported by

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