Skip to content

Sort out pynco vs. nco on PyPI #70

@mx-moth

Description

@mx-moth

This project goes under a few names in different places, and the differences are confusing some users.

  • The repository is called pynco
  • It uses the nco programs
  • The Python package is published as nco on PyPI. The documentation instructs users to pip install nco
  • There is also a package named pynco on PyPI, owned by the maintainers of this project, but has not been updated since 2015
  • The package is named pynco on conda-forge
  • nco on conda-forge is the nco programs that this project binds to
  • The Python module that users import is called nco

The project should settle on using either pynco or nco, but not both. As nco is an established project that this project binds to, my vote is to settle on pynco. To move everything to pynco the following steps would be required:

  • Call the package pynco on PyPI
    • Update the package name in the package metadata
    • Update the README and documentation to instruct used to install the correct package
    • Release version 2.0.0 of pynco to PyPI
    • Deprecate the nco PyPI package
  • Rename the Python module to pynco
    • Update the documentation to reflect this change
    • Add a backwards compatibility nco import, with a deprecation warning. Two options:
      • Ship two modules in the package, nco and pynco. Importing nco would raise a DeprecationWarning but otherwise be an alias for the correct pynco module.
      • The pynco PyPI package only provides the pynco module. The nco PyPI package provides the nco module which depends on pynco. When a user calls import nco a deprecation warning is raised instructing users to move to pynco.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions