diff --git a/.circleci/config.yml b/.circleci/config.yml index 762639a3..7f084e43 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -14,10 +14,6 @@ jobs: command: | conda config --set always_yes yes --set changeps1 no conda install requests termcolor - - run: - name: Validate affiliated package JSON repository - command: | - python affiliated/validate_registry.py - run: name: Validate roles JSON file command: | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 040a0862..cb1731e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,11 @@ For general information on the contribution process, see the [Astropy core packa # Affiliated Packages -To propose inclusion of a package as an affiliated package (or propose a change in your package's status), you must make a PR modifying the `/affiliated/registry.json` file in this repository. The details of the review process are outlined at http://affiliated.astropy.org. +To propose inclusion of a package as an affiliated package, we work with pyOpenSci to support +the review process, which when complete will lead to your package being listed here. +The details of the review process are outlined at http://affiliated.astropy.org. # Modifying Roles in the Team section + * Modify the `roles.json` file * Preview locally by opening `team.html` in your browser. Note that most browsers restrict local file access (needed to access your local copy of `roles.json`), so you'll need to configure your browser to allow this - details depend on the browser, but usually you find it in some sort of "developer" menu. diff --git a/about.html b/about.html index 3382e82a..b8c7d086 100755 --- a/about.html +++ b/about.html @@ -110,11 +110,6 @@
The core also provides this documentation, and a variety of utilities - that simplify starting other python astronomy/astrophysics packages. As - described in the following section, these simplify the process of - creating affiliated packages.
If you are interested in starting an affiliated package, or have a - package you are interested in making more compatible with astropy, the - astropy core package includes features that simplify and homogenize - package management. Astropy provides a - package template - that provides a common - way to organize a package, to make your life simpler. You can use this - template either with a new package you are starting or an existing - package to give it most of the organizational tools Astropy provides, - including the documentation, testing, and Cython-building tools. See - the - usage instructions in the template - for further details.
- -To then get your package listed on the registry, take a look at the - - guidelines for becoming an affiliated package , and then post - your intent on the - astropy-dev mailing list. The Astropy - coordination committee, in consultation with the community, will provide - you feedback on the package, and will add it to the registry when it is - approved.
+The authoritative listing of current affiliated packages is available at + http://affiliated.astropy.org. + That page also describes the process to get a package listed as an affiliated package.
The simplest way to install and keep up-to-date most affiliated packages is to use the Anaconda python distribution. This distribution includes the Astropy core package already built in, and you can then easily install or update affiliated packages using the Astropy Conda channel of binary installable packages. Once you have Anaconda installed, you can do conda search --channel astropy some_affiliated_package. Most importantly, you can then install them with conda install --channel astropy some_affiliated_package. The Astropy channel is maintained by the Astropy Project on Github via code in the conda-channel-astropy repository.
If you do not have Anaconda or wish to install from source, for most affiliated packages, downloading the source code and doing python setup.py install will work. Many also support the Astropy core package's additional build and install options, as they use the affiliated package template (detailed more in the Becoming an Affiliated Package section). That said, affiliated packages are developed independently of the Astropy core library. This means they are free to develop their packages as they see fit, and can have a variety of different requirements or unusual install procedures. Hence you should refer to the package's documentation first if you encounter problems.
All packages should be available on PyPI. Some are available via conda, particularly + through the conda-forge channel. That said, affiliated packages are developed + independently of the Astropy core library. You should refer to the package's + documentation first if you encounter problems.
The following table lists all current Astropy coordinated packages. They are determined from the json file, which is the actual authoritative registry.
- -Total number of coordinated packages:
+The following table lists all current Astropy coordinated packages.
+Total number of coordinated packages:
| - | - | - | - | |
|---|---|---|---|---|
| Loading... | -- | - | - | - |
| - | - | |||
If you are a developer of an astronomy package and would like your package - to become affiliated with the Astropy Project, please take a look at the - - instructions for proposing an affiliated package. We recommend that you - also take a look at the +
Astropy uses the pyOpenSci peer review process + to vet affiliated packages. If you are a developer of an astronomy package and would like your package to become + affiliated with the Astropy Project, you submit your package directly to pyOpenSci. + Astropy will be involved in the review, which will allow your package to become an + affiliated package through that review process. You can also opt to be fast tracked through + JOSS if desired. Read the pyOpenSci author guide to learn + + how to get started with submitting a package to pyOpenSci through their affiliated partner program Guidebook. +
+ +In addition to pyOpenSci criteria, we also apply - guidelines for reviewing affiliated packages since this will give you a + Astropy-specific guidelines for reviewing affiliated packages. + This will give you a sense of whether your package is ready for review. Broadly speaking, your package should:
If you are considering creating a new astronomy package and would like it @@ -285,13 +254,52 @@
We recommend that you join the astropy-affiliated-maintainers mailing list to be kept informed of updates to the package template, as well as to have any dicussions related to setting up affiliated packages.
- +Additionally, it is also acceptable to use +pyOpenSci Python Package Guide +if you think that better suits your package needs.
+We recommend that you join the astropy-affiliated-maintainers mailing list to be kept informed of any dicussions related to affiliated packages.
+Thank you for your interest! Please see Becoming an Affiliated Package above. When in doubt, feel free to contact Astropy Affiliated Editors for advice.
+ +Please contact pyOpenSci, as per Peer Review Guidelines & Policies.
+ +Please see Requesting package removal from the pyOpenSci ecosystem.
+ +Welcome and thank you! We usually do not switch out all our Editors at the same time, + so the incumbent co-Editor could help you contact pyOpenSci to add you to + pyOpenSci editorial board + with the understanding that we are taking the person you are replacing off that board + and that your role is Astropy- and astronomy-focused.
+ +Your name would also be added to Astropy Team under the same role.
+ +Welcome and thank you! Please submit the sign-up form that can be found under +Become a pyOpenSci reviewer. Do not forget to check "Astropy"/"astronomy"/"astrophysics" +when you see them as options.
+ +It is important that you understand your reviews will be done in public. There is no option to remain anonymous.
+ +