| Name | codeframe JSON |
| Version |
0.5.15
JSON |
| download |
| home_page | https://gitlab.com/jaromrax/codeframe |
| Summary | Automatically created environment for python package |
| upload_time | 2024-04-17 14:14:01 |
| maintainer | None |
| docs_url | None |
| author | me |
| requires_python | None |
| license | GPL2 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
COMPLETE REFACTOR --------- LAST WORKING VERSION HERE
=====================================================
Project codeframe
=================
*Creates a simple package structure, Fire, git, PyPI, bumpversion,
pytest and configfile ready*
Introduction
------------
To create a new python project is a bit tedious task, especially if one
doesn\'t know how to.
This purpose of this package is to make a simple, but still functional
project structure.
Installation
------------
`pip3 install codeframe`
Usage
-----
Try just:
`codeframe myproject myunit`
This will create:
- subdirectory named `myproject` and inside:
- **hardlink** to `bin/myproject` named `bin_myproject`,
- unit `myunit`, that is soft-linked as `test_myunit`, so it works
with `pytest`,
- `version.py`, that works with `bumpversion`
- subsubdirectory `myproject`, that contains softlinks to `../` so
that the package structure works
- `setup.py` file, where you need to fill the requirements list and
other things
- `README.org`, that will generate `README.md` when `./distcheck` is
run
- with `config` module it **creates** a new config DIR
`~/.config/myproject`
- and some less important stuff
Highlights:
-----------
1. The modules should be callable in `jupyter` that is opened in the
`myproj` directory.
2. The hardlink `bin_myproject` make the script inside `bin/` callable
(but git pull from elsewhere looses the hardlink!)
3. Installable on local system with the usual command
`pip3 install -e .`
4. `config` module can be both - used at a new project and imported
from any project `from codeframe import config`
./distcheck
-----------
- generates `README.md`
- creates git commit
- bumpversion release
- pushes to PyPI
Notes for development
---------------------
Thanks to `Fire`, each module can be developed separately and CLI can be
finally tuned in `bin/myproject` (hard-linked to `bin_myproject`) file.
TODO
====
- topbar from gregory
- key~enter~ \'\'
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/jaromrax/codeframe",
"name": "codeframe",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "me",
"author_email": "jaromrax@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/79/b1caccbc0eb26cd300f0040f5dd56effaadb4d7a27b1432bac9b1b4d43e2/codeframe-0.5.15.tar.gz",
"platform": null,
"description": "COMPLETE REFACTOR --------- LAST WORKING VERSION HERE\n=====================================================\n\nProject codeframe\n=================\n\n*Creates a simple package structure, Fire, git, PyPI, bumpversion,\npytest and configfile ready*\n\nIntroduction\n------------\n\nTo create a new python project is a bit tedious task, especially if one\ndoesn\\'t know how to.\n\nThis purpose of this package is to make a simple, but still functional\nproject structure.\n\nInstallation\n------------\n\n`pip3 install codeframe`\n\nUsage\n-----\n\nTry just:\n\n`codeframe myproject myunit`\n\nThis will create:\n\n- subdirectory named `myproject` and inside:\n- **hardlink** to `bin/myproject` named `bin_myproject`,\n- unit `myunit`, that is soft-linked as `test_myunit`, so it works\n with `pytest`,\n- `version.py`, that works with `bumpversion`\n- subsubdirectory `myproject`, that contains softlinks to `../` so\n that the package structure works\n- `setup.py` file, where you need to fill the requirements list and\n other things\n- `README.org`, that will generate `README.md` when `./distcheck` is\n run\n- with `config` module it **creates** a new config DIR\n `~/.config/myproject`\n- and some less important stuff\n\nHighlights:\n-----------\n\n1. The modules should be callable in `jupyter` that is opened in the\n `myproj` directory.\n2. The hardlink `bin_myproject` make the script inside `bin/` callable\n (but git pull from elsewhere looses the hardlink!)\n3. Installable on local system with the usual command\n `pip3 install -e .`\n4. `config` module can be both - used at a new project and imported\n from any project `from codeframe import config`\n\n./distcheck\n-----------\n\n- generates `README.md`\n- creates git commit\n- bumpversion release\n- pushes to PyPI\n\nNotes for development\n---------------------\n\nThanks to `Fire`, each module can be developed separately and CLI can be\nfinally tuned in `bin/myproject` (hard-linked to `bin_myproject`) file.\n\nTODO\n====\n\n- topbar from gregory\n- key~enter~ \\'\\'\n",
"bugtrack_url": null,
"license": "GPL2",
"summary": "Automatically created environment for python package",
"version": "0.5.15",
"project_urls": {
"Homepage": "https://gitlab.com/jaromrax/codeframe"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a79b1caccbc0eb26cd300f0040f5dd56effaadb4d7a27b1432bac9b1b4d43e2",
"md5": "0251b2ad167cc5b6895c801fc053c4ba",
"sha256": "0a9c5fdaad877737c246e571b175b1c59f113be3c42b976f14580996f749dc9b"
},
"downloads": -1,
"filename": "codeframe-0.5.15.tar.gz",
"has_sig": false,
"md5_digest": "0251b2ad167cc5b6895c801fc053c4ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29926,
"upload_time": "2024-04-17T14:14:01",
"upload_time_iso_8601": "2024-04-17T14:14:01.139362Z",
"url": "https://files.pythonhosted.org/packages/1a/79/b1caccbc0eb26cd300f0040f5dd56effaadb4d7a27b1432bac9b1b4d43e2/codeframe-0.5.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 14:14:01",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "jaromrax",
"gitlab_project": "codeframe",
"lcname": "codeframe"
}
