{ "info": { "author": "Benedikt Wiberg", "author_email": "benedikt@luminovo.ai", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7" ], "description": "

\n\"Code\n

\n\n# reliesl\nreliesl helps you automate your releases using `poetry` and GitLab CI.\n\n
\n \"Liesl\"\n
\n\n\"You've had a long day at work. Bugs have been squashed, features wered added and breaking changes documented. You've poured your heart and soul into this piece of software and the last thing seperating you from popping a bottle of champagne is having to release the newest version of your project on GitLab. Thank God there's reliesl to release your new software on GitLab (and maybe even open that bottle of champagne).\"\n\\- reliesl's secret admirer\n\n## Use `reliesl`\n`reliesl` grew up in a small village and thus is pretty opinionated. It assumes you are using `poetry` and keeping a `CHANGELOG.md`.\n`reliesl` provides two different commands to make your release process as smooth as possible:\n\n### reliesl release\nUsually added to your existing CI pipeline to manually trigger a new GitLab release based on the releasenotes given in CHANGELOG.md. Also adds the .whl of the package to the Asset section.\n\nIf you want to automatically release to PyPi (or TestPyPi if you are feeling less adventurous) you can use the `--pypi-release ` option like so:\n```bash\nreliesl release --pypi-release \n```\nFor authentication this requires the environement variables `PYPI_USERNAME` and `PYPI_PASSWORD` or `TESTPYPI_USERNAME` and `TESTPYPI_PASSWORD` to be set.\n\n### reliesl bump\nUsually run locally to take care of all cumbersome version edits in various files. \nIt will ask you whether you want to do a pre-release, bug fix, minor or major change, before automatically bumping your `poetry` version and parsing the `CHANGELOG.md` to update the `UNRELEASED` section with the right version number and date.\n\nUse the `--dry-run` flag to see what would happen without changing any files.\n\nAdditional files where version changes are needed can be configured via `--additional-file-edits `, like so: \n\n```\nreliesl bump --additional-file-edits \"file.txt\" '(semver = )(.*)()' \"file2.txt\" '(version: )(.*)()'\n```\n\nThe second capture group must be the semantic version you want to change.\nFor more information on python regular expressions look [here](https://docs.python.org/3.7/howto/regex.html).\n\n## Install `reliesl`\n\n### Local\nSimply run\n```bash\npoetry add --dev reliesl\n```\nor \n```bash\npip install reliesl\n```\n\n### GitLab-CI\nTo your .gitlab-ci.yml you need to add:\n\n - A new `- deploy` stage if you do not already have one (The release process should be the last stage)\n\n - A new job:\n```\nrelease:\n stage: deploy\n when: manual\n script:\n - pip install reliesl\n - reliesl release\n```\n\n\n### Environment Variables\nThe release script needs access to the GitLab API to create a new release. This requires a new environment variable(Under Settings > CI / CD > Variables):\n * Key: `PRIVATE_TOKEN`\n * Value: a valid private token that gives access to api calls for your project(Profile > Settings > Access Tokens)\n\n\n## Development\n\n### Pre-commit\nPlease make sure to have the pre-commit hooks installed.\nInstall [pre-commit](https://pre-commit.com/) and then run `pre-commit install` to register the hooks with git.\n\n### Makefile\nWe use [make](https://www.gnu.org/software/make/) to streamline our development workflow.\nRun `make help` to see all available commands.\n\n\n```\n$ make help \nhelp Show this help message\ncheck Run all static checks (like pre-commit hooks)\ntest Run all tests\ndev-install Install all the packages in the local python environment for development\nbump Bump reliesl version \n```\n\n\n## Acknowledgments\n\nThe picture of Liesl was stolen from here: https://ladiesoftheatre.tumblr.com/post/155234955388/you-may-think-this-kind-of-adventure-never-may\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/luminovo/public/reliesl", "keywords": "gitlab,release,continuous,integration", "license": "MIT", "maintainer": "Benedikt Wiberg", "maintainer_email": "benedikt@luminovo.ai", "name": "reliesl", "package_url": "https://pypi.org/project/reliesl/", "platform": "", "project_url": "https://pypi.org/project/reliesl/", "project_urls": { "Homepage": "https://gitlab.com/luminovo/public/reliesl", "Repository": "https://gitlab.com/luminovo/public/reliesl" }, "release_url": "https://pypi.org/project/reliesl/0.1.1/", "requires_dist": [ "requests (>=2.22,<3.0)", "semver (>=2.8,<3.0)", "toml (>=0.10.0,<0.11.0)", "click (>=7.0,<8.0)" ], "requires_python": ">=3.7,<4.0", "summary": "Reliesl is a tool for automatic release managment using the Gitlab CI.", "version": "0.1.1" }, "last_serial": 5957153, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "2553218ffd54f2f8355a798e0d345ae0", "sha256": "008a115c0a5faa0ca282d541cb752945b5910b8126e92c919645d73eee247e0f" }, "downloads": -1, "filename": "reliesl-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2553218ffd54f2f8355a798e0d345ae0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 22348, "upload_time": "2019-09-13T12:10:40", "url": "https://files.pythonhosted.org/packages/7d/8f/f0cb55b18d38b3ca4f0853da631dc93952d9eb48f4d0fdc02f8b7763c062/reliesl-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "623ad90fcd89e2aaf9e6b69595b02a11", "sha256": "5feb1464e57f886060a6d1a3b280d18219b57ed3cad81eaf2d31dfc98f737073" }, "downloads": -1, "filename": "reliesl-0.1.0.tar.gz", "has_sig": false, "md5_digest": "623ad90fcd89e2aaf9e6b69595b02a11", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 9084, "upload_time": "2019-09-13T12:10:42", "url": "https://files.pythonhosted.org/packages/c8/ca/2bd9dea42c78f18cd730d5e89efbcae38bb5f597cb169547c79fe4bf8c3b/reliesl-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "d5c9d9d5214c8fcf2ef00f36c466edd9", "sha256": "bf7f25846559d84b454705513463623174ea4589d6572f2ba40b71389a182584" }, "downloads": -1, "filename": "reliesl-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d5c9d9d5214c8fcf2ef00f36c466edd9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 22231, "upload_time": "2019-09-18T08:43:35", "url": "https://files.pythonhosted.org/packages/39/a7/e159c51d11157bdfe3b9ba2b7fbc1207a2e10c4d5a9962ba6f96ce1cb722/reliesl-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "95335a8b1d313461a025779904e02bca", "sha256": "e058fb992d735204a959a08a029cd44a998a448c2df82c3e7a973929fac4b4b5" }, "downloads": -1, "filename": "reliesl-0.1.1.tar.gz", "has_sig": false, "md5_digest": "95335a8b1d313461a025779904e02bca", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 8945, "upload_time": "2019-09-18T08:43:37", "url": "https://files.pythonhosted.org/packages/48/55/30431bfbd59ee859bb7ab9b041c22817c067db73623310cc00aecbe9b2c5/reliesl-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d5c9d9d5214c8fcf2ef00f36c466edd9", "sha256": "bf7f25846559d84b454705513463623174ea4589d6572f2ba40b71389a182584" }, "downloads": -1, "filename": "reliesl-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d5c9d9d5214c8fcf2ef00f36c466edd9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 22231, "upload_time": "2019-09-18T08:43:35", "url": "https://files.pythonhosted.org/packages/39/a7/e159c51d11157bdfe3b9ba2b7fbc1207a2e10c4d5a9962ba6f96ce1cb722/reliesl-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "95335a8b1d313461a025779904e02bca", "sha256": "e058fb992d735204a959a08a029cd44a998a448c2df82c3e7a973929fac4b4b5" }, "downloads": -1, "filename": "reliesl-0.1.1.tar.gz", "has_sig": false, "md5_digest": "95335a8b1d313461a025779904e02bca", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 8945, "upload_time": "2019-09-18T08:43:37", "url": "https://files.pythonhosted.org/packages/48/55/30431bfbd59ee859bb7ab9b041c22817c067db73623310cc00aecbe9b2c5/reliesl-0.1.1.tar.gz" } ] }