# make-home-links readme
Simplify your shell setup by making symlinks to your home folder.
It takes a TOML file and creates symlinks from your checkout.
## Prerequisites
* `pipx` or just `pip3`
## Installation
One of:
* `pipx install make-home-links`
* `pip install --user make-home-links`
Upgrading:
* `pipx upgrade make-home-links`
* `pip install --user -U make-home-links`
After installation, `make-home-links` command should become available:
```shell
make-home-links --help
make-home-links --version
```
## Development
The project uses [`hatch`](https://hatch.pypa.io/) behind the scenes.
### How to use
```shell
# reformat the code
make fmt
# run the cli
hatch run cli
# run the cli version
hatch run cli --version
# run the cli help
hatch run help
hatch run cli --help
# run mypy
hatch run types:check
# run tests
hatch run test
hatch run test -k usual_pytest_flags -m my_marker
# go to the dev shell
hatch shell
# build the distribution
hatch build
```
### Increase version
```shell
hatch version <new_version>
```
### Publishing
#### Test publishing
Create `.env.test` with contents (when doing first ever release, you will not be able to constrain the token to project -- create one for entire account and then switch to project-based token):
```shell
export HATCH_INDEX_USER=__token__
# token from "API tokens" of https://test.pypi.org/manage/account/
export HATCH_INDEX_AUTH=pypi-...
```
then publish to the testing PyPI:
```shell
hatch version <new_version>
source .env.test
hatch publish -r test -y
```
#### Publishing to prod
Create `.env.prod` with contents (when doing first ever release, you will not be able to constrain the token to project -- create one for entire account and then switch to project-based token):
```shell
export HATCH_INDEX_USER=__token__
# token from "API tokens" of https://pypi.org/manage/account/
export HATCH_INDEX_AUTH=pypi-...
```
then publish to the testing PyPI:
```shell
# maybe also: hatch version <new_version>
source .env.prod
hatch publish -r main -y
```
See also [`hatch publish`](https://hatch.pypa.io/1.9/publish/) documentation.
Raw data
{
"_id": null,
"home_page": null,
"name": "make-home-links",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli,command line,command-line,tool",
"author": null,
"author_email": "slavos1 <1396260+slavos1@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/84/45/f6b1f705a83a9d82cd13d985dbafa9a767f4c8f82e5dd870d48e36fe2b8e/make_home_links-0.1.0a1.tar.gz",
"platform": null,
"description": "# make-home-links readme\n\nSimplify your shell setup by making symlinks to your home folder.\n\nIt takes a TOML file and creates symlinks from your checkout.\n\n## Prerequisites\n\n* `pipx` or just `pip3`\n\n## Installation\n\nOne of:\n\n* `pipx install make-home-links`\n* `pip install --user make-home-links`\n\nUpgrading:\n\n* `pipx upgrade make-home-links`\n* `pip install --user -U make-home-links`\n\nAfter installation, `make-home-links` command should become available:\n\n```shell\nmake-home-links --help\nmake-home-links --version\n```\n\n## Development\n\nThe project uses [`hatch`](https://hatch.pypa.io/) behind the scenes.\n\n### How to use\n\n```shell\n# reformat the code\nmake fmt\n\n# run the cli\nhatch run cli\n\n# run the cli version\nhatch run cli --version\n\n# run the cli help\nhatch run help\nhatch run cli --help\n\n# run mypy\nhatch run types:check\n\n# run tests\nhatch run test\nhatch run test -k usual_pytest_flags -m my_marker\n\n# go to the dev shell\nhatch shell\n\n# build the distribution\nhatch build\n```\n\n### Increase version\n```shell\nhatch version <new_version>\n```\n\n### Publishing\n\n#### Test publishing\n\nCreate `.env.test` with contents (when doing first ever release, you will not be able to constrain the token to project -- create one for entire account and then switch to project-based token):\n```shell\nexport HATCH_INDEX_USER=__token__\n# token from \"API tokens\" of https://test.pypi.org/manage/account/\nexport HATCH_INDEX_AUTH=pypi-...\n```\n\nthen publish to the testing PyPI:\n\n```shell\nhatch version <new_version>\nsource .env.test\nhatch publish -r test -y\n```\n\n#### Publishing to prod\n\nCreate `.env.prod` with contents (when doing first ever release, you will not be able to constrain the token to project -- create one for entire account and then switch to project-based token):\n```shell\nexport HATCH_INDEX_USER=__token__\n# token from \"API tokens\" of https://pypi.org/manage/account/\nexport HATCH_INDEX_AUTH=pypi-...\n```\n\nthen publish to the testing PyPI:\n\n```shell\n# maybe also: hatch version <new_version>\nsource .env.prod\nhatch publish -r main -y\n```\n\nSee also [`hatch publish`](https://hatch.pypa.io/1.9/publish/) documentation.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Make symlinks to your home folder",
"version": "0.1.0a1",
"project_urls": {
"Documentation": "https://github.com/slavos1/make-home-links/README.md",
"Homepage": "https://github.com/slavos1/make-home-links",
"Issues": "https://github.com/slavos1/make-home-links/issues",
"Source": "https://github.com/slavos1/make-home-links"
},
"split_keywords": [
"cli",
"command line",
"command-line",
"tool"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "232caddaad60b87e04cf2638245de20b3f0f3ace4ff114e182cae3506ceee34e",
"md5": "0366c286e0d61d45a62cecfeb1f2f62b",
"sha256": "ceffe5d0214b0f962a47308b6061981197961b1555b40aa6c922a79f23523e77"
},
"downloads": -1,
"filename": "make_home_links-0.1.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0366c286e0d61d45a62cecfeb1f2f62b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5751,
"upload_time": "2024-01-22T22:51:40",
"upload_time_iso_8601": "2024-01-22T22:51:40.724902Z",
"url": "https://files.pythonhosted.org/packages/23/2c/addaad60b87e04cf2638245de20b3f0f3ace4ff114e182cae3506ceee34e/make_home_links-0.1.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8445f6b1f705a83a9d82cd13d985dbafa9a767f4c8f82e5dd870d48e36fe2b8e",
"md5": "6c7b2066d23bcd99f9f7023c794db7c3",
"sha256": "8bff9c496b277507db789ce770263b78929e07a76d2bb084e5d916271332bf9c"
},
"downloads": -1,
"filename": "make_home_links-0.1.0a1.tar.gz",
"has_sig": false,
"md5_digest": "6c7b2066d23bcd99f9f7023c794db7c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4852,
"upload_time": "2024-01-22T22:51:39",
"upload_time_iso_8601": "2024-01-22T22:51:39.456787Z",
"url": "https://files.pythonhosted.org/packages/84/45/f6b1f705a83a9d82cd13d985dbafa9a767f4c8f82e5dd870d48e36fe2b8e/make_home_links-0.1.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 22:51:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "slavos1",
"github_project": "make-home-links",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "make-home-links"
}
JSON
