Skip to content

Commit

Permalink
Half retemplate
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Sep 5, 2019
1 parent ba2cbc4 commit 7e20cfd
Show file tree
Hide file tree
Showing 21 changed files with 468 additions and 282 deletions.
57 changes: 46 additions & 11 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,40 @@ merge-check: &merge-check
name: Check if we need to merge upstream master
command: |
if [[ -n "${CIRCLE_PR_NUMBER}" ]]; then
git fetch origin --tags
git fetch origin +refs/pull/$CIRCLE_PR_NUMBER/merge:pr/$CIRCLE_PR_NUMBER/merge
git checkout -qf pr/$CIRCLE_PR_NUMBER/merge
fi
permission-run: &permission-run
name: Fix permssions for installing
command: |
sudo chown -R circleci:circleci /usr/local/bin
sudo chown -R circleci:circleci /usr/local/lib/python3.7/site-packages
sudo chown -R circleci:circleci /usr/local/share/
apt-run: &apt-install
name: Install apt packages
command: |
apt update
apt install -y graphviz build-essential
sudo-apt-run: &sudo-apt-install
name: Install apt packages
command: |
sudo apt update
sudo apt install -y graphviz build-essential
tox-install: &tox-install
name: Install Tox
command: |
pip install tox
tox-conda-install: &tox-conda-install
name: Install Tox-Conda
command: |
pip install tox-conda
version: 2
jobs:
egg-info-36:
Expand All @@ -41,30 +60,42 @@ jobs:
- run: *merge-check
- run: python setup.py egg_info

twine-check:
docker:
- image: circleci/python:3.7
steps:
- checkout
- run: *skip-check
- run: *merge-check
- run: *permission-run
- run: python setup.py sdist
- run: python -m pip install -U --user --force-reinstall twine
- run: python -m twine check dist/*

pip-install:
docker:
- image: continuumio/miniconda3
- image: circleci/python:3.7
steps:
- checkout
- run: *skip-check
- run: *merge-check
- run: *apt-install
- run:
name: Update pip
command: pip install -U pip
- run:
name: Install ndcube
command: pip install --progress-bar off -e .[all,dev]
- run: *permission-run
- run: *sudo-apt-install
- run: pip install -U pip
- run: pip install --progress-bar off .[all,dev]
- run: pip install -e .[all,dev]
- run: python setup.py develop

html-docs:
docker:
- image: continuumio/miniconda3
- image: circleci/python:3.7
steps:
- checkout
- run: *skip-check
- run: *merge-check
- run: *apt-install
- run: *tox-install
- run: *permission-run
- run: *sudo-apt-install
- run: pip install -U tox
- run: tox -e build_docs
- store_artifacts:
path: docs/_build/html
Expand All @@ -80,6 +111,10 @@ workflows:
- egg-info-36
- egg-info-37

twine-check:
jobs:
- twine-check

pip-install:
jobs:
- pip-install
Expand Down
Empty file modified .circleci/early_exit.sh
100755 → 100644
Empty file.
11 changes: 7 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -199,18 +199,21 @@ $RECYCLE.BIN/
### VScode: https://raw.githubusercontent.com/github/gitignore/master/Global/VisualStudioCode.gitignore
.vscode/*

### Extra Python Items and nccube Specific
### Extra Python Items and SunPy Specific
.hypothesis
.pytest_cache
sunpydata.sqlite
sunpydata.sqlite-journal
ndcube/_compiler.c
ndcube/cython_version.py
ndcube/version.py
sunpy/_compiler.c
sunpy/cython_version.py
docs/_build
docs/generated
docs/api/
docs/whatsnew/latest_changelog.txt
examples/**/*.asdf
# This is incase you run the figure tests
figure_test_images*
tags

### Pycharm(?)
.idea
Expand Down
2 changes: 0 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,3 @@ python:
- requirements: docs/rtd_requirements.txt
- method: pip
path: .
extra_requirements:
- dev
20 changes: 20 additions & 0 deletions .sunpy-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
default_context:
package_name: "ndcube"
module_name: "ndcube"
short_description: "A package for multi-dimensional contiguious and non-contiguious coordinate aware arrays."
long_description: "file: README.rst"
author_name: "The SunPy Community"
author_email: "[email protected]"
license: "BSD 2-Clause"
project_url: "http://docs.sunpy.org/projects/ndcube/"
project_version: "1.1.dev"
include_example_code: "n"
include_example_cython_code: "n"
include_cextern_folder: "n"
edit_on_github_extension: "True"
github_project: "sunpy/github"
use_azure_ci: "y"
use_read_the_docs: "y"
sphinx_theme: "sunpy-sphinx-theme"
initialize_git_repo: "n"
minimum_python_version: "3.6"
60 changes: 0 additions & 60 deletions .travis.yml

This file was deleted.

9 changes: 3 additions & 6 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
include README.rst
include CHANGES.rst
include LICENSE.rst
include CHANGELOG.rst

include ez_setup.py
include ah_bootstrap.py
include setup.cfg
include ndcube/tests/coveragerc
include pyproject.toml

recursive-include ndcube *.pyx *.c *.pxd
recursive-include docs *
Expand All @@ -27,10 +25,9 @@ include astropy_helpers/CHANGES.rst
include astropy_helpers/LICENSE.rst
recursive-include astropy_helpers/licenses *

include astropy_helpers/ez_setup.py
include astropy_helpers/ah_bootstrap.py

recursive-include astropy_helpers/astropy_helpers *.py *.pyx *.c *.h
recursive-include astropy_helpers/astropy_helpers *.py *.pyx *.c *.h *.rst
recursive-include astropy_helpers/astropy_helpers.egg-info *
# include the sphinx stuff with "*" because there are css/html/rst/etc.
recursive-include astropy_helpers/astropy_helpers/sphinx *
Expand Down
45 changes: 34 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
`ndcube`
========
ndcube
==========

|Latest Version| |codecov| |Powered by NumFOCUS| |Powered by Sunpy|
.. image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
:target: http://www.sunpy.org
:alt: Powered by SunPy Badge

.. |Powered by Sunpy| image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
:target: http://www.sunpy.org
.. |Latest Version| image:: https://img.shields.io/pypi/v/ndcube.svg
:target: https://pypi.python.org/pypi/ndcube/
.. |codecov| image:: https://codecov.io/gh/sunpy/ndcube/branch/master/graph/badge.svg
:target: https://codecov.io/gh/sunpy/ndcube
.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
:target: http://numfocus.org
A package for multi-dimensional contiguious and non-contiguious coordinate aware arrays.
----------------------------------------------------------------------------------------

ndcube is an open-source SunPy affiliated package for manipulating,
inspecting and visualizing multi-dimensional contiguous and non-contiguous
Expand Down Expand Up @@ -127,6 +123,33 @@ items.
For more information on contributing to ncdube or the SunPy
organization, please read the SunPy `contributing guide`_.

**Imposter syndrome disclaimer**: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not
ready to be an open source contributor; that your skills aren't nearly good
enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at
all, you can contribute code to open source. Contributing to open source
projects is a fantastic way to advance one's coding skills. Writing perfect code
isn't the measure of a good developer (that would disqualify all of us!); it's
trying to create something, making mistakes, and learning from those
mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either. You can
help out by writing documentation, tests, or even giving feedback about the
project (and yes - that includes giving feedback about the contribution
process). Some of these contributions may be the most valuable to the project as
a whole, because you're coming to the project with fresh eyes, so you can see
the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by
`Adrienne Lowe <https://github.com/adriennefriend>`_ for a
`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
ndcube based on its use in the README file for the
`MetPy project <https://github.com/Unidata/MetPy>`_.


Code of Conduct
---------------

Expand Down
62 changes: 37 additions & 25 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
@@ -1,49 +1,61 @@
name: $(BuildDefinitionName)_$(Date:yyyyMMdd)$(Rev:.rr)
variables:
"System.PreferGit": true
Agent.Source.Git.ShallowFetchDepth: 1
CI_NAME: Azure Pipelines
CI_BUILD_ID: $(Build.BuildId)
# These will need to be changed for your project.
CI_BUILD_URL: "https://dev.azure.com/sunpy/ndcube/_build/results?buildId=$(Build.BuildId)"

# These resources need to be setup on the Azure Pipeline website
# as a service connection (if it has not been already).
resources:
repositories:
- repository: sunpy
type: github
endpoint: sunpy
name: sunpy/azure-pipelines-template
ref: master

trigger:
tags:
include:
- 'v*'
exclude:
- '*dev*'
- '*pre*'
- '*post*'

jobs:
- template: azure-templates.yml
- template: run-tox-env.yml@sunpy
parameters:
name: Linux_36_offline
name: Linux_37_offline
os: linux
tox: py36-offline --

tox: py37-offline --
- template: azure-templates.yml
parameters:
name: pycodestyle
name: Linux_36_offline
os: linux
tox: pycodestyle --

- template: azure-templates.yml
parameters:
name: macOS_37_offline
os: macos
tox: py37-offline --
tox: py36-offline --

- template: azure-templates.yml
- template: run-tox-env.yml@sunpy
parameters:
name: Windows_36_offline
os: windows
tox: py36-offline --

- template: azure-templates.yml
- template: run-tox-env.yml@sunpy
parameters:
name: Linux_36_conda_offline
os: linux
tox: conda --
name: macOS_37_online
os: macos
tox: py37-online --

- template: azure-templates.yml
- template: run-tox-env.yml@sunpy
parameters:
name: Linux_37_sunpydev
name: Linux_37_astropydev
os: linux
tox: py37-sunpydev --
tox: py37-astropydev --

- template: azure-templates.yml
- template: run-tox-env.yml@sunpy
parameters:
name: Linux_37_astropydev
name: Linux_37_sunpydev
os: linux
tox: py37-astropydev --
tox: py37-sunpydev --
Loading

0 comments on commit 7e20cfd

Please sign in to comment.