blob: 24deaf63090bebe0e20d6bbd82b31b00c870a12b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# Contributing
Thank you for considering contributing to `wee-slack`!
## Requirements
* [`git`](https://git-scm.com)
* [`pipenv`](https://github.com/pypa/pipenv)
## Activating the development environment
The development environment contains a few useful tools. Before testing or
working on `wee-slack`, the development environment should be activated. This
will ensure you have access to the necessary development tools.
```
$ cd /path/to/wee-slack
$ pipenv shell
# Install the required development dependencies
$ pipenv install --dev
```
The rest of this document assumes that the development environment has been
activated, and that you have the latest development dependencies installed.
## Testing
Tests are executed with `pytest`. To run the tests, first navigate to the
project root, and then execute:
```
$ pytest
```
## Adding new dependencies
Add your desired dependencies to the appropriate header, specifying a version if
necessary, defaulting to `*` if not. Be extra careful if you are pinning a
specific version of a dependency, as we currently support multiple versions of
Python which may or may not have the version you specify available to it.
```
# use [package] for production dependencies
[package]
foo-package = "*"
# use [dev-packages] for development dependencies
[dev-packages]
bar-package = "*"
```
> **PRO TIP**
>
> You can also add dependencies without manually updating this file by running
> `pipenv install [--dev] <package...>`. This will automatically update the
> entry for the package in the `Pipfile` (and your local lockfile).
>
> For example, to add the `foo` and `bar` packages as development dependencies
> without specificying a version, you would run:
>
> ``` pipenv install --dev foo bar ```
## Updating dependencies
It's important to keep our dependencies up-to-date over time. Because we support
multiple versions of Python, we avoid committing the `Pipfile.lock` file (which
is added in `.gitignore`), in addition to avoiding pinning versions of packages.
To update the dependencies installed in your local virtual environment:
```
# Check for upstream updates
$ pipenv update --outdated
# Want to update everything?
$ pipenv update
# Want to update one package at a time?
$ pipenv update <pkg>
```
It's important to [run the tests](#testing) after updating dependencies to
ensure that the updated dependencies have not broken the build.
|
