dotenvhub


Namedotenvhub JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/Zaloog/dotenvhub
SummaryTerminal App to manage .env files written in Python powered by Textual
upload_time2024-05-25 07:00:03
maintainerNone
docs_urlNone
authorZaloog
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            <!-- These are examples of badges you might want to add to your README:
     please update the URLs accordingly

[![Built Status](https://api.cirrus-ci.com/github/<USER>/dotenvhub.svg?branch=main)](https://cirrus-ci.com/github/<USER>/dotenvhub)
[![ReadTheDocs](https://readthedocs.org/projects/dotenvhub/badge/?version=latest)](https://dotenvhub.readthedocs.io/en/stable/)
[![Coveralls](https://img.shields.io/coveralls/github/<USER>/dotenvhub/main.svg)](https://coveralls.io/r/<USER>/dotenvhub)
[![PyPI-Server](https://img.shields.io/pypi/v/dotenvhub.svg)](https://pypi.org/project/dotenvhub/)
[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/dotenvhub.svg)](https://anaconda.org/conda-forge/dotenvhub)
[![Monthly Downloads](https://pepy.tech/badge/dotenvhub/month)](https://pepy.tech/project/dotenvhub)
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter)](https://twitter.com/dotenvhub)
-->

[![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)

# dotenvhub

> Your Terminal App to manage your .env files

# Introduction
![header](https://raw.githubusercontent.com/Zaloog/dotenvhub/main/images/image_header.PNG)

DotEnvHub helps storing and accessing your project specific .env files from a central place to setup your environment variables.
Supporting you to follow the [12-factor] principles when developing applications.

# Features
- Organizes files centrally under `user_data_dir` following the [XDG] Basedir Spec
- Saves your last selected shell automatically via a config file under `user_config_dir`
- Supports Creating/Editing/Deleting files in your dotenvhub
- Currently provides 3 ways to set your environment variables:
  1. Copy the Shell specific command to set the environment variables into your clipboard
  2. Create a Copy of the selected file into your current working directory
  3. Copy the path of the selected file to be used with e.g. [python-dotenv] \
  without creating a copy in the project

# Installation
You can install dotenvhub with:
```bash
python -m pip install dotenvhub
```
Or using [pipx]
```bash
pipx install dotenvhub
```

# Usage
## Using the Graphical UI

After Installation the Interface can be opened with:
```bash
dot
```
Use `Ctrl+c` to close the interface.

## Using the CLI
The Creation of a Copy in the CWD and copying the Shell String
to set the environment variables can also be done directly in the CLI:

To create a copy of `FOLDER/FILE` from DotEnvHub and save it as `SAVENAME` in your CWD:
```bash
dot copy <FOLDER/FILE> -N <SAVENAME>
```

To copy the string to clipboard to set `FOLDER/FILE` from DotEnvHub in your `Shell` of Choice:
```bash
dot shell <FOLDER/FILE> -S <SHELL>
```

# Feedback and/or Issues
If you have feedback or find bugs, feel free to open an Issue.

:warning: DotEnvHub uses `pyperclip` to handle copy/paste actions.
Based on the pyperclips documentation, you might need additional packages installed
on linux systems like `xclip` or `xsel` which can be installed with:

```bash
sudo apt-get install xclip
sudo apt-get install xsel
```

like mentioned [here](https://pyperclip.readthedocs.io/en/latest/)


[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
[platformdirs]: https://platformdirs.readthedocs.io/en/latest/
[python-dotenv]: https://github.com/theskumar/python-dotenv
[pipx]: https://github.com/pypa/pipx
[12-factor]: https://12factor.net

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Zaloog/dotenvhub",
    "name": "dotenvhub",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Zaloog",
    "author_email": "gramslars@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/fc/f9/0612c08977a7589dacdcc89c3497fce07e70daaa017a097a2e34e7e34ece/dotenvhub-0.2.0.tar.gz",
    "platform": "any",
    "description": "<!-- These are examples of badges you might want to add to your README:\n     please update the URLs accordingly\n\n[![Built Status](https://api.cirrus-ci.com/github/<USER>/dotenvhub.svg?branch=main)](https://cirrus-ci.com/github/<USER>/dotenvhub)\n[![ReadTheDocs](https://readthedocs.org/projects/dotenvhub/badge/?version=latest)](https://dotenvhub.readthedocs.io/en/stable/)\n[![Coveralls](https://img.shields.io/coveralls/github/<USER>/dotenvhub/main.svg)](https://coveralls.io/r/<USER>/dotenvhub)\n[![PyPI-Server](https://img.shields.io/pypi/v/dotenvhub.svg)](https://pypi.org/project/dotenvhub/)\n[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/dotenvhub.svg)](https://anaconda.org/conda-forge/dotenvhub)\n[![Monthly Downloads](https://pepy.tech/badge/dotenvhub/month)](https://pepy.tech/project/dotenvhub)\n[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter)](https://twitter.com/dotenvhub)\n-->\n\n[![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)\n\n# dotenvhub\n\n> Your Terminal App to manage your .env files\n\n# Introduction\n![header](https://raw.githubusercontent.com/Zaloog/dotenvhub/main/images/image_header.PNG)\n\nDotEnvHub helps storing and accessing your project specific .env files from a central place to setup your environment variables.\nSupporting you to follow the [12-factor] principles when developing applications.\n\n# Features\n- Organizes files centrally under `user_data_dir` following the [XDG] Basedir Spec\n- Saves your last selected shell automatically via a config file under `user_config_dir`\n- Supports Creating/Editing/Deleting files in your dotenvhub\n- Currently provides 3 ways to set your environment variables:\n  1. Copy the Shell specific command to set the environment variables into your clipboard\n  2. Create a Copy of the selected file into your current working directory\n  3. Copy the path of the selected file to be used with e.g. [python-dotenv] \\\n  without creating a copy in the project\n\n# Installation\nYou can install dotenvhub with:\n```bash\npython -m pip install dotenvhub\n```\nOr using [pipx]\n```bash\npipx install dotenvhub\n```\n\n# Usage\n## Using the Graphical UI\n\nAfter Installation the Interface can be opened with:\n```bash\ndot\n```\nUse `Ctrl+c` to close the interface.\n\n## Using the CLI\nThe Creation of a Copy in the CWD and copying the Shell String\nto set the environment variables can also be done directly in the CLI:\n\nTo create a copy of `FOLDER/FILE` from DotEnvHub and save it as `SAVENAME` in your CWD:\n```bash\ndot copy <FOLDER/FILE> -N <SAVENAME>\n```\n\nTo copy the string to clipboard to set `FOLDER/FILE` from DotEnvHub in your `Shell` of Choice:\n```bash\ndot shell <FOLDER/FILE> -S <SHELL>\n```\n\n# Feedback and/or Issues\nIf you have feedback or find bugs, feel free to open an Issue.\n\n:warning: DotEnvHub uses `pyperclip` to handle copy/paste actions.\nBased on the pyperclips documentation, you might need additional packages installed\non linux systems like `xclip` or `xsel` which can be installed with:\n\n```bash\nsudo apt-get install xclip\nsudo apt-get install xsel\n```\n\nlike mentioned [here](https://pyperclip.readthedocs.io/en/latest/)\n\n\n[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html\n[platformdirs]: https://platformdirs.readthedocs.io/en/latest/\n[python-dotenv]: https://github.com/theskumar/python-dotenv\n[pipx]: https://github.com/pypa/pipx\n[12-factor]: https://12factor.net\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Terminal App to manage .env files written in Python powered by Textual",
    "version": "0.2.0",
    "project_urls": {
        "Documentation": "https://github.com/Zaloog/dotenvhub",
        "Homepage": "https://github.com/Zaloog/dotenvhub",
        "Source": "https://github.com/Zaloog/dotenvhub"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f425be083345a3f5d27cd0de1328b459aeb40688a08713bb39e3e81fe4c4ec9",
                "md5": "13063794d001011bbfacd9b76068186b",
                "sha256": "c2bcf9ab465e886def63288642a8aa0eceb7c9187a39ef9b401b6df86d50aa24"
            },
            "downloads": -1,
            "filename": "dotenvhub-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "13063794d001011bbfacd9b76068186b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 15435,
            "upload_time": "2024-05-25T07:00:01",
            "upload_time_iso_8601": "2024-05-25T07:00:01.540660Z",
            "url": "https://files.pythonhosted.org/packages/6f/42/5be083345a3f5d27cd0de1328b459aeb40688a08713bb39e3e81fe4c4ec9/dotenvhub-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fcf90612c08977a7589dacdcc89c3497fce07e70daaa017a097a2e34e7e34ece",
                "md5": "7df469c8ed4ace26dba2eef722fc1ed2",
                "sha256": "8adcf1124c7e160b07b6874cc706a1ca7a50f613af2523692be18ae272e0e598"
            },
            "downloads": -1,
            "filename": "dotenvhub-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7df469c8ed4ace26dba2eef722fc1ed2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 89211,
            "upload_time": "2024-05-25T07:00:03",
            "upload_time_iso_8601": "2024-05-25T07:00:03.936092Z",
            "url": "https://files.pythonhosted.org/packages/fc/f9/0612c08977a7589dacdcc89c3497fce07e70daaa017a097a2e34e7e34ece/dotenvhub-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-25 07:00:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Zaloog",
    "github_project": "dotenvhub",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "dotenvhub"
}
        
Elapsed time: 0.45727s