Skip to content

conda-forge/sp-repo-review-feedstock

Repository files navigation

About sp-repo-review-feedstock

Feedstock license: BSD-3-Clause

Home: https://github.com/scientific-python/cookie

Package license: BSD-3-Clause

Summary: A copier/cookiecutter template for new Python projects based on the Scientific Python Developer Guide

Documentation: https://learn.scientific-python.org/development

A copier/cookiecutter template for new Python projects based on the Scientific Python Developer Guide. What makes this different from other templates for Python packages? Lives with the Scientific-Python Development Guide: Every decision is clearly documented and every tool described, and everything is kept in sync. Eleven different backends to choose from for building packages. Optional VCS versioning for most backends. Template generation tested in GitHub Actions using nox. Supports generation with copier, cookiecutter, and cruft. Supports GitHub Actions if targeting a github.com url (the default), and adds experimental GitLab CI support otherwise. Includes several compiled backends using pybind11, with wheels produced for all platforms using cibuildwheel. Provides sp-repo-review to evaluate existing repos against the guidelines, with a WebAssembly version integrated with the guide. All checks cross-linked. Follows PyPA best practices and regularly updated.

Current build status

All platforms: noarch disabled

Current release info

Name Downloads Version Platforms
Conda Recipe Conda Downloads Conda Version Conda Platforms

Installing sp-repo-review

Installing sp-repo-review from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, sp-repo-review can be installed with conda:

conda install sp-repo-review

or with mamba:

mamba install sp-repo-review

It is possible to list all of the versions of sp-repo-review available on your platform with conda:

conda search sp-repo-review --channel conda-forge

or with mamba:

mamba search sp-repo-review --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search sp-repo-review --channel conda-forge

# List packages depending on `sp-repo-review`:
mamba repoquery whoneeds sp-repo-review --channel conda-forge

# List dependencies of `sp-repo-review`:
mamba repoquery depends sp-repo-review --channel conda-forge

About conda-forge

Powered by NumFOCUS

conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.

A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI it is possible to build and upload installable packages to the conda-forge anaconda.org channel for Linux, Windows and OSX respectively.

To manage the continuous integration and simplify feedstock maintenance, conda-smithy has been developed. Using the conda-forge.yml within this repository, it is possible to re-render all of this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender.

For more information, please check the conda-forge documentation.

Terminology

feedstock - the conda recipe (raw material), supporting scripts and CI configuration.

conda-smithy - the tool which helps orchestrate the feedstock. Its primary use is in the construction of the CI .yml files and simplify the management of many feedstocks.

conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)

Updating sp-repo-review-feedstock

If you would like to improve the sp-repo-review recipe or build a new package version, please fork this repository and submit a PR. Upon submission, your changes will be run on the appropriate platforms to give the reviewer an opportunity to confirm that the changes result in a successful build. Once merged, the recipe will be re-built and uploaded automatically to the conda-forge channel, whereupon the built conda packages will be available for everybody to install and use from the conda-forge channel. Note that all branches in the conda-forge/sp-repo-review-feedstock are immediately built and any created packages are uploaded, so PRs should be based on branches in forks, and branches in the main repository should only be used to build distinct package versions.

In order to produce a uniquely identifiable distribution:

  • If the version of a package is not being increased, please add or increase the build/number.
  • If the version of a package is being increased, please remember to return the build/number back to 0.

Feedstock Maintainers

About

A conda-smithy repository for sp-repo-review.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

 
 
 

Contributors