Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimporter/pysetenv
Set environment variables before running a command
https://github.com/jimporter/pysetenv
environment-variables python utility
Last synced: about 1 month ago
JSON representation
Set environment variables before running a command
- Host: GitHub
- URL: https://github.com/jimporter/pysetenv
- Owner: jimporter
- License: bsd-3-clause
- Created: 2018-06-03T21:05:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T03:48:11.000Z (6 months ago)
- Last Synced: 2024-09-22T09:12:39.037Z (about 2 months ago)
- Topics: environment-variables, python, utility
- Language: Python
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# pysetenv
[![PyPi version][pypi-image]][pypi-link]
[![Build status][ci-image]][ci-link]
[![Coverage status][codecov-image]][codecov-link]
**pysetenv** is a simple Python-based program to allow users to set environment
variables before executing a command, similar to the POSIX [`env`][env] command.
## Why?
pysetenv is designed as a support package to help authors of other Python
packages create command-line strings like you'd expect from `sh` or the `env`
command. Generally, pysetenv will only be installed on Windows systems, with
POSIX systems using `sh` or `env`. For example, in your `setup.py`, you would
write:
```python
setup(
# ...
install_requires=['pysetenv;platform_system=="Windows"'],
)
```
Then somewhere in your code, you could call pysetenv:
```python
subprocess.call(['pysetenv', ...])
```
## Command-line reference
Usage: `pysetenv [OPTION]... [NAME=VALUE]... [--] [COMMAND [ARG]...]`
pysetenv supports a subset of common options available to various
implementations of `env`. It executes `COMMAND` with any supplied arguments
(`ARG`) after modifying the environment as specified by the previous arguments.
Any arguments of the form `NAME=VALUE` will set an environment variable `NAME`
to the value of `VALUE`. If `COMMAND` is not specified, pysetenv will print the
resulting environment instead.
In addition, the following options are supported:
* `-i`: Ignore any environment variables inherited by this process
* `-u NAME`: Unset the environment variable `NAME`
* `-h`, `--help`: Show a help message and exit
* `--version`: Show the current version and exit
As an extension to the `env` command, the options above and the variable
definitions can be separated from the section for defining the command to run
with `--`:
```sh
pysetenv -uFOO BAR=value -- echo hello
```
## License
This project is licensed under the [BSD 3-clause license](LICENSE).
[pypi-image]: https://img.shields.io/pypi/v/pysetenv.svg
[pypi-link]: https://pypi.python.org/pypi/pysetenv
[ci-image]: https://github.com/jimporter/pysetenv/actions/workflows/build.yml/badge.svg
[ci-link]: https://github.com/jimporter/pysetenv/actions/workflows/build.yml?query=branch%3Amaster
[codecov-image]: https://codecov.io/gh/jimporter/pysetenv/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/jimporter/pysetenv
[env]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/env.html