Source

locally /

Filename Size Date modified Message
1.2 KB
Add case with pure Python package with no dependencies, such as SCons.
3.5 KB
extract_zip: allow subdir to be empty to extract everything
6.0 KB
Sync PySDL2 with locally.py
4.1 KB
04.ftp-server.py: Workaround against sys.path bug on Linux (directory
17.8 KB
05.wesnoth.py: add gtkpath to PATH for pkg-config
4.8 KB
06.get-virtualenv.py: update virtualenv from 0.11.6 to 12.0.7
10.3 KB
05.wesnoth.py: update MinGW GCC to newer version
1.7 KB
README rewrite
81 B
move LICENSE to UNLICENSE, because public domain is not licensing,
6.0 KB
locally.py: unzip() needs os import for makedirs
Locally helps to run projects directly from a source
code checkout without installing.

This repository includes a collection of independent,
standalone, single script snippets that show how to
bootstrap/run projects directly from a source. There
is also a 'locally' module with helpers gathered as a
result of writing such scripts.

All code is placed in public domain.


Usage
-----
Your goal is to create a script (typically called
bootstrap.py) that does everything necessary to get
your project running without tedious installation
steps or documentation read.

You do so by copying/pasting relevant pieces of code
available from this repository.

The script should automate as much manual steps as
possible and provide feedback for user where it is
required. The scripts usually sets environment,
fetches archives, dependencies and executes source
code in this setup.


What is `locally` exactly and why would you need it
---------------------------------------------------
It is examples of convention, layout, best practices
and it is also a library of Python helpers to run
your apps without installing. Very useful for
development, because:

  * it lowers the barrier for contribution
  * reduces time loss between checkout and run

Finally, it enables users to try latest code without
overhead of building and packaging things themselves.


Where to start
--------------
Study by example starting from 01.xxx.py script to
see what works for you. When you get the concept,
take a look into `locally` module for other useful
helpers.


Links
-----
See examples:
https://code.google.com/p/rainforce/wiki/TheRoadmap#Bootstrap


Credits
-------
anatoly techtonik <techtonik@gmail.com>
..contributions are welcome..


License
-------
Public domain or MIT.