# Franklin
## Use conventional commits
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
The commit message should be structured as follows:
<type>[optional scope][!]: <description>
[optional body]
[[BREAKING CHANGE:] optional footer(s)]
The commit contains the following structural elements, to communicate intent to the consumers of your library:
**fix:** a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
**feat:** a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
BREAKING CHANGE: a commit that has a footer **BREAKING CHANGE:**, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
Types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends **build:**, **chore:**, **ci:**, **docs:**, **style:**, **refactor:**, **perf:**, **test:**, and others.
Footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.
# Releases
Running `release-tag.sh` creates and pushes a version tag maching the version in the pushed `pyproject.toml`. This triggers Github actions that first amends the remote `CHANGELOG.md` and then builds and publishes a conda package for that version.
# Developer Notes
union of dependencies for franklin, franklin-educator and franklin-admin are included in requirements.txt to make conda package building work
For conda packages, franklin-admin depends on franklin-educator, which depends on franklin. This is to make it possible to install like this or each user group:
students:
conda install munch-group::franklin
educators:
conda install munch-group::franklin-educator
admin:
conda install munch-group::franklin-admin
Raw data
{
"_id": null,
"home_page": null,
"name": "franklin-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Kasper Munch <kaspermunch@birc.au.dk>",
"keywords": "teaching, data, jupyter, docker, git",
"author": null,
"author_email": "Kasper Munch <kaspermunch@birc.au.dk>",
"download_url": "https://files.pythonhosted.org/packages/4d/13/556c3a0d95dbe28706450ec48b03b36ee3e7d811f42d708b766f7a27a400/franklin_cli-0.25.110.tar.gz",
"platform": null,
"description": "\n# Franklin\n\n\n## Use conventional commits\n\nThe Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.\n\nThe commit message should be structured as follows:\n\n <type>[optional scope][!]: <description>\n\n [optional body]\n\n [[BREAKING CHANGE:] optional footer(s)]\n\nThe commit contains the following structural elements, to communicate intent to the consumers of your library:\n\n**fix:** a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).\n\n**feat:** a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).\n\nBREAKING CHANGE: a commit that has a footer **BREAKING CHANGE:**, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.\n\nTypes other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends **build:**, **chore:**, **ci:**, **docs:**, **style:**, **refactor:**, **perf:**, **test:**, and others.\n\nFooters other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.\n\nAdditional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit\u2019s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.\n\n# Releases\n\nRunning `release-tag.sh` creates and pushes a version tag maching the version in the pushed `pyproject.toml`. This triggers Github actions that first amends the remote `CHANGELOG.md` and then builds and publishes a conda package for that version.\n\n\n# Developer Notes\n\nunion of dependencies for franklin, franklin-educator and franklin-admin are included in requirements.txt to make conda package building work\n\nFor conda packages, franklin-admin depends on franklin-educator, which depends on franklin. This is to make it possible to install like this or each user group:\n\nstudents:\n\n conda install munch-group::franklin\n\neducators:\n\n conda install munch-group::franklin-educator\n\nadmin:\n\n conda install munch-group::franklin-admin\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Terminal client for Jupyter exercises",
"version": "0.25.110",
"project_urls": {
"Documentation": "https://munch-group.org/franklin",
"Homepage": "https://munch-group.org/franklin",
"Issues": "https://github.com/munch-group/franklin/issues",
"Repository": "https://github.com/munch-group/franklin.git"
},
"split_keywords": [
"teaching",
" data",
" jupyter",
" docker",
" git"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "05b55661453e9c1a70c44fff88178f76acd1754567271f6213349b08d60c1c3e",
"md5": "3b777d05917dc7d3d043c5e25574ea86",
"sha256": "355fce0ced01adc05ca193856f3e6c83d169ff8b24dc00967bf6f8a3f8551431"
},
"downloads": -1,
"filename": "franklin_cli-0.25.110-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b777d05917dc7d3d043c5e25574ea86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 128644,
"upload_time": "2025-08-19T21:06:22",
"upload_time_iso_8601": "2025-08-19T21:06:22.720466Z",
"url": "https://files.pythonhosted.org/packages/05/b5/5661453e9c1a70c44fff88178f76acd1754567271f6213349b08d60c1c3e/franklin_cli-0.25.110-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4d13556c3a0d95dbe28706450ec48b03b36ee3e7d811f42d708b766f7a27a400",
"md5": "c26296098e2c01e562371253219d6774",
"sha256": "9e7100dcacae65c52c995c95196157299fd38c2adcdf406925571432f5008c25"
},
"downloads": -1,
"filename": "franklin_cli-0.25.110.tar.gz",
"has_sig": false,
"md5_digest": "c26296098e2c01e562371253219d6774",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 122768,
"upload_time": "2025-08-19T21:06:24",
"upload_time_iso_8601": "2025-08-19T21:06:24.000667Z",
"url": "https://files.pythonhosted.org/packages/4d/13/556c3a0d95dbe28706450ec48b03b36ee3e7d811f42d708b766f7a27a400/franklin_cli-0.25.110.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 21:06:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "munch-group",
"github_project": "franklin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "franklin-cli"
}
JSON
