Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
G
geomag-algorithms
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ghsc
National Geomagnetism Program
geomag-algorithms
Commits
451b9df6
Commit
451b9df6
authored
5 years ago
by
Jeremy M Fee
Browse files
Options
Downloads
Patches
Plain Diff
Update develop documentation based on black auto formatter
parent
37052668
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/develop.md
+65
-43
65 additions, 43 deletions
docs/develop.md
with
65 additions
and
43 deletions
docs/develop.md
+
65
−
43
View file @
451b9df6
Development Dependencies
# Development Dependencies
========================
These instructions only need to be completed if you plan on developing new
These instructions only need to be completed if you plan on developing new
code for this project,
and
may also be used to run a local copy of the code.
code for this project,
but
may also be used to run a local copy of the code.
## Clone Project
Begin Developing
This project uses a forking workflow.
----------------
https://guides.github.com/activities/forking/
1.
Install
`obspy`
,
`pycurl`
,
`flake8`
,
`pytest`
,
`pytest-cov`
,
`webtest`
.
1.
Fork this project on Github.
> Using Anaconda is recommended ( https://conda.io/miniconda.html ).
conda config --add channels conda-forge
https://github.com/usgs/geomag-algorithms.git
conda create --name geomagenv obspy pycurl flake8 pytest pytest-cov webtest
source activate geomagenv
2.
Fork this project on Github ( https://guides.github.com/activities/forking/ ).
2.
Clone your fork
https://github.com/{YOUR_GITHUB_ACCOUNT}/geomag-algorithms.git
3.
Clone your fork
git clone https://github.com/{YOUR_GITHUB_ACCOUNT}/geomag-algorithms.git
git clone https://github.com/{YOUR_GITHUB_ACCOUNT}/geomag-algorithms.git
cd geomag-algorithms
cd geomag-algorithms
git remote add upstream https://github.com/usgs/geomag-algorithms.git
git remote add upstream https://github.com/usgs/geomag-algorithms.git
4.
Use branches to develop new features and submit pull requests.
3.
Use branches to develop new features and submit pull requests.
## Install Dependencies
Developer Tools
-
Using
`pipenv`
---------------
https://pipenv.kennethreitz.org/en/latest/
-
**Linting errors**
> `pyenv` is also useful for installing specific/multiple versions of python
Check for linting errors using Flake8
>
> - https://github.com/pyenv/pyenv
> - https://github.com/pyenv-win/pyenv-win
cd geomag-algorithms
pipenv install --dev
flake8
pipenv shell
-
Or, using Miniconda/Anaconda
https://conda.io/miniconda.html
conda config --add channels conda-forge
conda create --name geomagenv obspy pycurl black pre-commit pytest pytest-cov webtest
conda activate geomagenv
## Coding Standards
This project uses _The Black Code Style_
https://black.readthedocs.io/en/stable/the_black_code_style.html
## Developer Tools
-
**Code Formatting**
This project uses the
`black`
formatter, combined with
`pre-commit`
, to
automatically format code before it is committed.
VSCode ( https://code.visualstudio.com/ ), with the
`Python`
extension,
can be configured to automatically format using
`black`
when files are saved.
The
`Formatting Toggle`
extension is also useful.
You can also manually format all files in the project by running
black .
-
**Unit tests**
-
**Unit tests**
Run unit tests using PyTest
cd geomag-algorithms
Run unit tests using PyTest
pytest
-
**Unit test coverage**
pytest
cd geomag-algorithms
-
**Unit test coverage**
pytest --cov=geomagio
-
**Automatically run linting and tests while developing**
pytest --cov=geomagio
(Requires NodeJS)
cd geomag-algorithms
## Routine Git Updates
npm install
npm run watch
There are also "npm run" aliases for individual commands which are listed by running
-
**Pulling new changes**
npm run
When starting a new branch, or before putting in a pull request, make sure
you have the latest changes from the
`upstream`
repository.
> The local master branch should only be used for synchonization with the
> `upstream` repository, and we recommend always using the `--ff-only` option.
Coding Standards
git checkout master
----------------
git pull --ff-only upstream master
This project adheres to PEP8 standards in most cases:
-
**Rebase an existing branch**
https://www.python.org/dev/peps/pep-0008
**PEP8 Exceptions**
After downloading updates into the master branch, feature branches need to be
rebased so they include any already merged changes.
-
Hanging/Visual indents (E122, E126, E127, E128, E131)
git checkout FEATURE-BRANCH
git rebase master
- line continuations should use two indentations (8 spaces).
Resolve any rebase conflicts.
- do not use visual indents.
If you have already pushed this branch to your fork, you may need to force push
because branch history has changed.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment