Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

scaffolding

Project description

korpokkur
========================================

korpokkur is command tool set for scaffold.


(only support 2.7 and 3.3

korpokkur has several subcommands. list below.

- list
- create
- scan


list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

$ korpokkur list
package -- tiny python package scaffold (this is sample)
scaffold -- korpokkur scaffold template template

create
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

$ korpokkur create package .
package (package name)[sample]:foo
version (version number for project)[0.0]:0.1
description (package description)[-]:sample package

$ tree foo
foo
|-- CHANGES.txt
|-- README.rst
|-- foo
| `-- tests
| `-- __init__.py
`-- setup.py

sometime, it's annoying that asking via interactive shell when unknown setting is found.
so, enable to pass value by config file.

.. code:: bash

$ korpokkur create --config ./foo.ini package .

.. code:: foo.ini

[scaffold]
package = foo
version = 0.1
description = sample package

or json file is also ok.

.. code:: bash

$ korpokkur create --config ./foo.json package .

.. code:: foo.ini

{"package": "foo", "version": "0.1", "sample package"}


scan
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

scan is dry-run operation about create.

.. code:: bash

$ korpokkur scan package
package (package name)[sample]:foo
d[c]: /tmp/foo
d[c]: /tmp/foo/foo
f[c]: ~/korpokkur/scaffolds/package/+package+/CHANGES.txt -> /tmp/foo/CHANGES.txt
f[m]: ~/korpokkur/scaffolds/package/+package+/README.rst.tmpl -> /tmp/foo/README.rst
f[m]: ~/korpokkur/scaffolds/package/+package+/setup.py.tmpl -> /tmp/foo/setup.py
version (version number for project)[0.0]:0.1
description (package description)[-]:sample package
d[c]: /tmp/foo/foo/tests
f[c]: ~/korpokkur/scaffolds/package/+package+/+package+/tests/__init__.py -> /tmp/foo/foo/tests/__init__.py
f[c]: ~/korpokkur/scaffolds/pygitignore/+package+/.gitignore -> /tmp/foo/.gitignore
----------------------------------------
*input values*
{
"version": "0.1",
"package": "foo",
"description": "sample package"
}

output information what files are generated and what values are asked.

Project details


Download files

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

Files for korpokkur, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size korpokkur-0.1-py3-none-any.whl (41.8 kB) File type Wheel Python version 3.5 Upload date Hashes View hashes
Filename, size korpokkur-0.1.tar.gz (21.0 kB) File type Source Python version None Upload date Hashes View hashes

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