Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

New view of make.

Project description

Introduction
============

pymk is a script that provides the sam functionality that "makefile" does, but
the "makefile" (mkfile.py) is a python script. Code of mkfile.py is cleared, and
it can do more things (like check all files from all folders and subfolders named
"migrations").

Why reimplement makefile?
=========================
Setting dependency in makefile is not flexible. Supports only "if file is newear,
then rebuild". Pymk can have in it's dependency whatever python code you want.
Event if you want to check something using network.

Tutorial
========
First, we need to make an empty "mkfile.py". Pymk will try to search for a list
of taks and will find nothing.
::
$ touch mkfile.py
$ pymk
Avalible tasks:

Now we need to make simple task. Put this in mkfile.py
::
from pymk.task import BaseTask, AddTask

@AddTask
class task(BaseTask):

@classmethod
def build(cls):
print 'Hello'

And now we can execute
::
$ pymk
Avalible tasks:
task
$ pymk task
* Building 'task'
Hello

If you want pymk to run some task by default, just put this line at the end of
the mkfile.py
::
_DEFAULT=task

And run
::
$ pymk
* Building 'task'
Hello

Ok, but now our task are build every time we make it. We need to make a file in
our script, and point which file we are creating. Out mkfile.py should look like
this
::
from pymk.task import BaseTask, AddTask
from pymk.extra import touch

@AddTask
class task(BaseTask):

output_file = 'a.out'

@classmethod
def build(cls):
touch(cls.output_file)

_DEFAULT=task

And then we execute
::
$ pymk
* Building 'task'
$ pymk
* 'task' is up to date
$ cat a.out
bulded!

And now we start playing. We need some dependency. Here's the file
::
from pymk.task import BaseTask, AddTask
from pymk.dependency import FileChanged

@AddTask
class task(BaseTask):
output_file = 'a.out'

dependencys = [
FileChanged('b.out'),
]

@classmethod
def build(cls):
fp = open(cls.output_file, 'a')
fp.write('bulded!\n')
fp.close()

_DEFAULT=task

We can now try:
::
$ pymk
Could not create file b.out
$ ls
mkfile.py mkfile.pyc

But this will not work becouse of absance of b.out file. So we will create it
and try again.
::
$ touch b.out
$ pymk
* Building 'task'
$ ls
a.out b.out mkfile.py mkfile.pyc
$ pymk
* 'task' is up to date
$ touch b.out
$ pymk
* Building 'task'

As we can see, a.out will be created when b.out will be changed. This dependency
is implemented for files that can changed by external programs (or programmers).
If we need a task depedency, like "if task changed, rebuild me" we can make something
like that
::
from pymk.task import BaseTask, AddTask
from pymk.dependency import FileChanged

@AddTask
class secon_task(BaseTask):
output_file = 'b.out'

@classmethod
def build(cls):
fp = open(cls.output_file, 'a')
fp.write('bulded!\n')
fp.close()

@AddTask
class task(BaseTask):
output_file = 'a.out'

dependencys = [
secon_task.dependency_FileChanged,
]

@classmethod
def build(cls):
fp = open(cls.output_file, 'a')
fp.write('bulded!\n')
fp.close()

_DEFAULT=task

And new can run this:
::
$ rm *.out # if something was left before
$ pymk
* Building 'secon_task'
* Building 'task'
$ pymk
* 'task' is up to date
$ touch b.out
$ pymk
* Building 'task'


Documentation
=============
API documentation can be founded here: http://socek.org/pymk/doc/

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Pymk-0.1.3-py2.7.egg (27.1 kB) Copy SHA256 hash SHA256 Egg 2.7 Dec 18, 2012
Pymk-0.1.3.tar.gz (8.6 kB) Copy SHA256 hash SHA256 Source None Dec 18, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page