Skip to content

Commit 4f89ba9

Browse files
author
Leah Wasser
committedSep 19, 2019
adding deps and dev envt setup
1 parent 9d1303d commit 4f89ba9

5 files changed

+70
-1
lines changed
 

‎.pre-commit-config.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
repos:
2+
- repo: https://github.com/ambv/black
3+
rev: stable
4+
hooks:
5+
- id: black
6+
language_version: python3.6

‎CONTRIBUTING.rst

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Get Started!
2+
============
3+
4+
Ready to contribute? Here's how to set up EarthPy for local development.
5+
6+
1. Fork the repository on GitHub
7+
--------------------------------
8+
9+
To create your own copy of the repository on GitHub, navigate to the
10+
`earthlab/abc-classroom <https://github.com/earthlab/abc-classroom>`_ repository
11+
and click the **Fork** button in the top-right corner of the page.
12+
13+
2. Clone your fork locally
14+
--------------------------
15+
16+
Use ``git clone`` to get a local copy of your EarthPy repository on your
17+
local filesystem::
18+
19+
$ git clone git@github.com:your_name_here/abc-classroom.git
20+
$ cd abc-classroom/
21+
22+
3. Set up your fork for local development
23+
-----------------------------------------
24+
25+
Create an environment
26+
^^^^^^^^^^^^^^^^^^^^^
27+
28+
Using conda, there are two options.
29+
30+
1. The easiest option is to create an environment from the
31+
``environment.yml`` file.
32+
Note that this will only allow you to test against one version of python
33+
locally, but this is the recommended option on Windows and MacOS::
34+
35+
$ conda env create -f environment.yml
36+
$ conda activate abc-dev
37+
38+
Install the package
39+
^^^^^^^^^^^^^^^^^^^
40+
41+
Once your earthpy-dev environment is activated, install EarthPy in editable
42+
mode, along with the development requirements and pre-commit hooks::
43+
44+
$ pip install -e .
45+
$ pip install -r dev-requirements.txt
46+
$ pre-commit install

‎README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,11 @@
55

66
## Try it!
77

8-
Run `pip install -e.` in the directory of this README.
8+
Run `pip install -e .` in the directory of this README.
9+
10+
11+
## Dev
12+
13+
14+
15+

‎dev-requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
sphinx==1.8.0
22
sphinx-autobuild==0.7.1
33
sphinx_rtd_theme
4+
codecov==2.0.15
5+
bumpversion==0.5.3
6+
pre-commit==1.18.1

‎environment.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
name: abc-dev
2+
channels:
3+
- conda-forge
4+
dependencies:
5+
# Github API
6+
- github3.py
7+

0 commit comments

Comments
 (0)
Please sign in to comment.