Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
W
WindEnergyToolbox
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
wtlib
WindEnergyToolbox
Commits
1eabdb0b
Commit
1eabdb0b
authored
8 years ago
by
davidovitch
Browse files
Options
Downloads
Patches
Plain Diff
docs: mention conda install instruction only once, extend dependency list description
parent
08dd2952
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/developer-guide.md
+13
-34
13 additions, 34 deletions
docs/developer-guide.md
with
13 additions
and
34 deletions
docs/developer-guide.md
+
13
−
34
View file @
1eabdb0b
...
@@ -138,9 +138,18 @@ use ```deactivate``` to deactivate the environment.
...
@@ -138,9 +138,18 @@ use ```deactivate``` to deactivate the environment.
-
[
matplotlib
](
http://matplotlib.org/
)
-
[
matplotlib
](
http://matplotlib.org/
)
-
[
pytables
](
http://www.pytables.org/
)
-
[
pytables
](
http://www.pytables.org/
)
-
[
pyscaffold
](
http://pyscaffold.readthedocs.org/en/
)
-
[
pyscaffold
](
http://pyscaffold.readthedocs.org/en/
)
-
pytest, pytest-cov
-
[
pytest
](
https://pypi.python.org/pypi/pytest
)
-
[
pytest-cov
](
https://pypi.python.org/pypi/pytest-cov/
)
-
six,
[
future
](
http://python-future.org/index.html
)
-
six,
[
future
](
http://python-future.org/index.html
)
-
nose, sphinx, blosc, pbr, psutil, coverage, setuptools_scm
-
[
parimeko
](
http://www.paramiko.org/
)
-
[
parimeko
](
http://www.paramiko.org/
)
-
[
pandoc
](
http://pandoc.org/
)
,
[
pypandoc
](
https://pypi.python.org/pypi/pypandoc
)
:
convert markdown formatted readme file to rst for PyPi compatibility. See also
issue #22. Note that
```pandoc```
is available in Anaconda. When installing
```
pypandoc``` via pip you'll need to install ```pandoc``` via your package
manager (Linux/Mac).
- [twine](https://pypi.python.org/pypi/twine): upload package to
[PyPi](https://pypi.python.org/pypi)
Install the necessary Python dependencies using the conda package manager:
Install the necessary Python dependencies using the conda package manager:
...
@@ -148,6 +157,7 @@ Install the necessary Python dependencies using the conda package manager:
...
@@ -148,6 +157,7 @@ Install the necessary Python dependencies using the conda package manager:
>> conda install setuptools_scm future h5py pytables pytest pytest-cov nose sphinx blosc pbr paramiko
>> conda install setuptools_scm future h5py pytables pytest pytest-cov nose sphinx blosc pbr paramiko
>> conda install scipy pandas matplotlib cython xlrd coverage xlwt openpyxl psutil pandoc
>> conda install scipy pandas matplotlib cython xlrd coverage xlwt openpyxl psutil pandoc
>> conda install -c conda-forge pyscaffold pypandoc --no-deps
>> conda install -c conda-forge pyscaffold pypandoc --no-deps
>> conda install --channel https://conda.anaconda.org/pbrod twine --no-deps
```
```
Note that ```--no-deps``` avoids that newer packages from the channel
Note that ```--no-deps``` avoids that newer packages from the channel
...
@@ -208,39 +218,6 @@ To be written
...
@@ -208,39 +218,6 @@ To be written
## Make and upload wheels to PyPi
## Make and upload wheels to PyPi
Uploading wheels to [PyPi](https://pypi.python.org/pypi) is easy thanks to
[```twine```](https://pypi.python.org/pypi/twine).
Install ```twine``` using conda:
```
>> conda install --channel https://conda.anaconda.org/pbrod twine --no-deps
```
Or pip:
```
>> pip install twine
```
One additional complication with PyPi is that the package description is required
to be in the ```rst``` format, while the ```wetb``` readme file is currently
formatted in ```md```. To solve this,
[```pypandoc```](https://pypi.python.org/pypi/pypandoc) can be used to convert
```
README.md
``` on the fly to ```
rst
```. A discussion on how this can be done
is also recorded in issue #22.
Install ```
pypandoc
``` using conda:
```
>> conda install pandoc
>> conda install -c conda-forge pypandoc --no-deps
```
However, when installing via pip you will need to install
[```pandoc```](http://pandoc.org/) first via your Linux/Mac package manager,
then you can install the Python wrapper:
```
>> pip install pypandoc
```
Workflow for creating and uploading wheels is as follows:
Workflow for creating and uploading wheels is as follows:
- Make tag: ```git tag "vX.Y.Z"```, and push tag to remote: ```git push --tags```
- Make tag: ```git tag "vX.Y.Z"```, and push tag to remote: ```git push --tags```
...
@@ -260,4 +237,6 @@ In case of problems:
...
@@ -260,4 +237,6 @@ In case of problems:
- Make sure the version tag is compliant with
- Make sure the version tag is compliant with
[PEP 440](https://www.python.org/dev/peps/pep-0440/), otherwise ```twine upload```
[PEP 440](https://www.python.org/dev/peps/pep-0440/), otherwise ```twine upload```
will fail. This means commit hashes can not be part of the version number.
will fail. This means commit hashes can not be part of the version number.
Note that when your git working directory is not clean, the scheme for automatic
versioning number will add ```dirty``` to the version number.
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