Skip to content

Commit a7e9fa8

Browse files
committed
Fix linting errors
1 parent 43d3fd4 commit a7e9fa8

File tree

2 files changed

+34
-27
lines changed

2 files changed

+34
-27
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,13 @@ There are a few ways to do this, but we prefer to use
4646
create and manage a Python virtual environment specific to this
4747
project.
4848

49-
If you already have `pyenv` and `pyenv-virtualenv` configured you can
50-
take advantage of the `setup-env` tool in this repo to automate the
51-
entire environment configuration process.
49+
We recommend using the `setup-env` script located in this repository,
50+
as it automates the entire environment configuration process. The
51+
dependencies required to run this script are
52+
[GNU `getopt`](https://github.com/util-linux/util-linux/blob/master/misc-utils/getopt.1.adoc),
53+
[`pyenv`](https://github.com/pyenv/pyenv), and [`pyenv-virtualenv`](https://github.com/pyenv/pyenv-virtualenv).
54+
If these tools are already configured on your system, you can simply run the
55+
following command:
5256

5357
```console
5458
./setup-env
@@ -57,27 +61,34 @@ entire environment configuration process.
5761
Otherwise, follow the steps below to manually configure your
5862
environment.
5963

60-
#### Installing and using `pyenv` and `pyenv-virtualenv` ####
64+
#### Installing and using GNU `getopt`, `pyenv`, and `pyenv-virtualenv` ####
6165

62-
On the Mac, we recommend installing [brew](https://brew.sh/). Then
63-
installation is as simple as `brew install pyenv pyenv-virtualenv` and
66+
On macOS, we recommend installing [brew](https://brew.sh/). Then
67+
installation is as simple as `brew install gnu-getopt pyenv pyenv-virtualenv` and
6468
adding this to your profile:
6569

6670
```bash
71+
# GNU getopt must be explicitly added to the path since it is
72+
# keg-only (https://docs.brew.sh/FAQ#what-does-keg-only-mean)
73+
export PATH="$(brew --prefix)/opt/gnu-getopt/bin:$PATH"
74+
75+
# Setup pyenv
6776
export PYENV_ROOT="$HOME/.pyenv"
6877
export PATH="$PYENV_ROOT/bin:$PATH"
6978
eval "$(pyenv init --path)"
7079
eval "$(pyenv init -)"
7180
eval "$(pyenv virtualenv-init -)"
7281
```
7382

74-
For Linux, Windows Subsystem for Linux (WSL), or on the Mac (if you
83+
For Linux, Windows Subsystem for Linux (WSL), or macOS (if you
7584
don't want to use `brew`) you can use
7685
[pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) to
7786
install the necessary tools. Before running this ensure that you have
7887
installed the prerequisites for your platform according to the
7988
[`pyenv` wiki
8089
page](https://github.com/pyenv/pyenv/wiki/common-build-problems).
90+
GNU `getopt` is included in most Linux distributions as part of the
91+
[`util-linux`](https://github.com/util-linux/util-linux) package.
8192

8293
On WSL you should treat your platform as whatever Linux distribution
8394
you've chosen to install.
@@ -121,11 +132,10 @@ you can begin to use `pyenv`.
121132
For a list of Python versions that are already installed and ready to
122133
use with `pyenv`, use the command `pyenv versions`. To see a list of
123134
the Python versions available to be installed and used with `pyenv`
124-
use the command `pyenv install --list`. You can read more
125-
[here](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md) about
126-
the many things that `pyenv` can do. See
127-
[here](https://github.com/pyenv/pyenv-virtualenv#usage) for the
128-
additional capabilities that pyenv-virtualenv adds to the `pyenv`
135+
use the command `pyenv install --list`. You can read more about
136+
the [many things that `pyenv` can do](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md).
137+
See the [usage information](https://github.com/pyenv/pyenv-virtualenv#usage)
138+
for the additional capabilities that pyenv-virtualenv adds to the `pyenv`
129139
command.
130140

131141
#### Creating the Python virtual environment ####
@@ -153,13 +163,10 @@ At this point the pre-commit checks will run against any files that
153163
you attempt to commit. If you want to run the checks against the
154164
entire repo, just execute `pre-commit run --all-files`.
155165

156-
## Public domain ##
166+
## License ##
157167

158-
This project is in the public domain within the United States, and
159-
copyright and related rights in the work worldwide are waived through
160-
the [CC0 1.0 Universal public domain
161-
dedication](https://creativecommons.org/publicdomain/zero/1.0/).
168+
This project is released as open source under the [MIT license](LICENSE).
162169

163-
All contributions to this project will be released under the CC0
164-
dedication. By submitting a pull request, you are agreeing to comply
165-
with this waiver of copyright interest.
170+
All contributions to this project will be released under the same MIT license.
171+
By submitting a pull request, you are agreeing to comply with this waiver of
172+
copyright interest.

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,19 +146,19 @@ WeeWX](https://weewx.com/docs.html) that they support.
146146
> is compatible with your saved data, and prevents inadvertent upgrades to a new
147147
> major version.
148148

149-
| Image:tag | Description |
150-
|-----------|-------------|
151-
|`felddy/weewx:5`| The most recent image matching the major version number. Most users will use this tag. |
152-
|`felddy/weewx:5.1`| The most recent image matching the major and minor version numbers. |
153-
|`felddy/weewx:5.1.0`| An exact image version. |
149+
| Image:tag | Description |
150+
| -------------------- | --------------------------------------------------------------------------------------- |
151+
| `felddy/weewx:5` | The most recent image matching the major version number. Most users will use this tag. |
152+
| `felddy/weewx:5.1` | The most recent image matching the major and minor version numbers. |
153+
| `felddy/weewx:5.1.0` | An exact image version. |
154154

155155
See the [tags tab](https://hub.docker.com/r/felddy/weewx/tags) on Docker
156156
Hub for a list of all the supported tags.
157157

158158
## Volumes ##
159159

160-
| Mount point | Purpose |
161-
|-------------|----------------|
160+
| Mount point | Purpose |
161+
| ----------- | ------------------------------------------------------------------------------------------------- |
162162
| `/data` | [WeeWX root](https://weewx.com/docs/5.1/usersguide/where/#location-of-weewx-components) directory |
163163

164164
## Building from source ##

0 commit comments

Comments
 (0)