Skip to content

Commit 1fbb4c7

Browse files
committed
underscored
1 parent fcfd9b5 commit 1fbb4c7

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Build Status](https://travis-ci.org/pavloo/config_py.svg?branch=master)](https://travis-ci.org/pavloo/config_py)
44

5-
## configpy
5+
## config_py
66
*A Python library for managing application configurations based on [Convention Over Configuration](https://en.wikipedia.org/wiki/Convention_over_configuration) principle*.
77

88
This library is trying to solve the next problem: when you run an app in different environments (`development`, `test` etc.), you need to load different configuration parameters based on those environments. For example, you run an app in *development* with `DB_USERNAME = 'root'`, but in *production* you would like that value to be `DB_USERNAME = os.getenv('DB_USER')`.
@@ -19,7 +19,7 @@ This library is trying to solve the next problem: when you run an app in differe
1919

2020
### Installation
2121
```
22-
pip install configpy
22+
pip install config-py
2323
```
2424

2525
### Basic usage
@@ -32,7 +32,7 @@ This package provides a CLI for scaffolding configuration setup. Assuming you ha
3232
```
3333
If you are in `project` directory, in order to generate a configuration for `my_package`, run:
3434
```
35-
configpy -p my_package
35+
config_py -p my_package
3636
```
3737
The command above will generate a `config` package inside of `my_package`, so that directory structure looks like this after:
3838
```
@@ -95,7 +95,7 @@ There is a use case when you may want to have a root configuration package, and
9595
```
9696
in `project` directory run:
9797
```
98-
configpy
98+
config_py
9999
```
100100
It will result in creating root `config` module:
101101
```
@@ -122,12 +122,12 @@ and running `python -m my_package.main` and `python -m my_package1.main` respect
122122
### Other options
123123
In order to get a list of other available options, run:
124124
```
125-
configpy -h
125+
config_py -h
126126
```
127127

128128
If you want to use different name of ENV_VAR providing environment setup (`dev`, `stage`...) than `WSGI_ENV` you can use `-e` or `--env_var` option while generating config:
129129
```
130-
configpy -p my_module -e NAME_OF_ENVIRONMENT_VAR
130+
config_py -p my_module -e NAME_OF_ENVIRONMENT_VAR
131131
```
132132
### License
133133
This project is licensed under the [MIT License](LICENSE).

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Over Configuration principle.
1010
"""
1111

12-
setup(name='configpy',
12+
setup(name='config-py',
1313
description='A Python package for managing configuration files in your apps',
1414
long_description=long_description,
1515
version=version.__version__,
@@ -36,7 +36,7 @@
3636
],
3737
entry_points={
3838
'console_scripts': [
39-
'configpy=config_py.bin.config_py:config_py'
39+
'config_py=config_py.bin.config_py:config_py'
4040
]
4141
}
4242
)

0 commit comments

Comments
 (0)