Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed links in readme, test command in Makefile and versioning #2

Merged
merged 1 commit into from
Jan 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ __pycache__/
env/
build/
develop-eggs/
#dist/
dist/
downloads/
eggs/
.eggs/
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ create_env:
delete_env:
@eval $(DELETE_COMMAND)

.PHONY: all help release conda_release pypi clean dist tests create_env delete_env
.PHONY: all help release release_requirements conda_release pypi clean dist tests create_env delete_env dist_test pypi_test release_test
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

## About <a name = "about"></a>

A YAML configuration wrapper. [PYPI Package](https://pypi.org/manage/project/yaml-config-wrapper/releases/)
A YAML configuration
wrapper. [PYPI Package](https://pypi.org/project/yaml-config-wrapper/)

## Table of Contents

Expand All @@ -14,7 +15,7 @@ A YAML configuration wrapper. [PYPI Package](https://pypi.org/manage/project/yam
+ [Creating a config file](#configuration)
+ [Set the required environment variables](#env_variables)
+ [Manually install the library](#manual_install)
+ [Prerequisites](#configuration)
+ [Prerequisites](#prerequisites)
+ [Install the requirements](#installing_req)
+ [Run the Unit Tests](#unit_tests)
+ [Continuous Integration](#ci)
Expand Down Expand Up @@ -42,7 +43,9 @@ conf = Configuration(config_src='confs/template_conf.yml',

### Creating a config file <a name = "configuration"></a>

There are two already example yml configs under [confs](confs). An example structure is the following:
There are two already example yml configs
under [confs](https://github.com/drkostas/yaml-config-wrapper/tree/master/confs). An example structure
is the following:

```yaml
tag: production
Expand All @@ -69,7 +72,9 @@ The `!ENV` flag indicates that you are passing an environmental value to this at
the values/environmental var names as you wish.

There is also the option to create a validation schema the enforces a specific yaml structure. The
default dummy version is the [default_schema.json](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/yaml_config_wrapper/default_schema.json) file.
default dummy version is
the [default_schema.json](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/yaml_config_wrapper/default_schema.json)
file.

### Set the required environment variables <a name = "env_variables"></a>

Expand All @@ -86,8 +91,9 @@ $ export EMAIL_ADDRESS=Gmail Bot <foobar@gmail.com>
$ export GMAIL_API_KEY=123
```

The best way to do that, is to create a .env file ([example](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/env_example)), and source it before
running the code.
The best way to do that, is to create a .env
file ([example](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/env_example)),
and source it before running the code.

## Manually install the library <a name = "manual_install"></a>

Expand All @@ -113,16 +119,18 @@ $ echo $SHELL

### Install the requirements <a name = "installing_req"></a>

All the installation steps are being handled by the [Makefile](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/Makefile). First, create a file
called `~/.pypirc` with your pypi login details, as follows:
All the installation steps are being handled by
the [Makefile](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/Makefile). First,
create a file called `~/.pypirc` with your pypi login details, as follows:

```
[pypi]
username = your_pypi_username
password = your_pypi_password
```

Then, modify the python version and everything else you need in the [settings.ini](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/settings.ini).
Then, modify the python version and everything else you need in
the [settings.ini](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/settings.ini).

Finally, execute the following commands:

Expand All @@ -147,10 +155,14 @@ check the [setup guide](https://circleci.com/docs/2.0/language-python/).

Again, you should set
the [above-mentioned environmental variables](#env_variables) ([reference](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-context))
and for any modifications, edit the [circleci config](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/.circleci/config.yml).
and for any modifications, edit
the [circleci config](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/.circleci/config.yml)
.

## License <a name = "license"></a>

This project is licensed under the MIT License - see the [LICENSE](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/LICENSE) file for details.
This project is licensed under the MIT License - see
the [LICENSE](https://raw.githubusercontent.com/drkostas/yaml-config-wrapper/master/LICENSE) file for
details.

<a href="https://www.buymeacoffee.com/drkostas" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
8 changes: 4 additions & 4 deletions settings.ini
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
[DEFAULT]
# All sections below are required unless otherwise specified
host = github
lib_name = yaml_config_wrapper
lib_name = yaml-config-wrapper
user = drkostas
description = A YAML configuration wrapper.
keywords = yaml, yml, config, configuration, wrapper
author = Kostas Georgiou
author_email = georgiou.kostas94@gmail.com
copyright = Kostas Georgiou
branch = master
version = 0.0.2
version = 0.0.3
testing_version = 0.0.11
min_python = 3.6
audience = Developers
language = English
# Add licenses and see current list in `setup.py`
license = apache2
# From 1-7: Planning Pre-Alpha Alpha Beta Production Mature Inactive
status = 5
# From 0-6: Planning Pre-Alpha Alpha Beta Production Mature Inactive
status = 4

# Optional. Same format as setuptools requirements
requirements = requirements.txt
Expand Down