Data

Tools

Indexes

Applications

Experiments

Open Source Science

cythononpypi

https://github.com/adrienplacais/cythononpypi

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: AdrienPlacais
  • Language: Python
  • Default Branch: main
  • Size: 152 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created about 1 year ago · Last pushed 9 months ago
Metadata Files
Readme Citation

README.md

Cython on PyPI

A test package for distributing Cython on (Test)PyPI.

CI

The .github/workflows/CI.yml allows to test the package with gh actions.

CD

Using cibuildwheel seems to be the easiest solution. Most of it is configured in pyproject.toml. Note that Windows will not interpret single quotes correctly. The tool.cibuildwheel.test-command must be 'pytest {project}/tests -m "my_mark"' (do not invert the single and double quotes).

Manual release (use CD instead)

The commands in make pypi would allow publishing a tagged version of the package on PyPI. The thing is, with Cython compiled, the wheel file is refused (.whl, built distribution). Note that uploading the .tar.gz (source distribution) works.

setuptools_scm

Automates the version number in pyproject.toml, according to the tag. Note that if cython updates the .c file and this file is tracked, building the wheel will update the repo. So setuptools_scm will set a new local version number: vX.Y.Z+dev0-slkfjslfjas-sdnalkd instead of desired vX.Y.Z. Current workaround is removing .c files from repo.

Solution

Now, the list of architectures/OS to build or exclude are explicitly written in the buildplat variable in .github/workflows/cd.yml. Generally speaking, problem comes from non-existing .whl that cannot be compiled on specific architectures/OS. They could be compiled, but this is not so important.

[!IMPORTANT] In the end, it was necessary to manually set which OS and architectures should be built. This is also what other libraries, such as scipy or numpy, do. Maybe I'll have to update this workflow from time to time...

Note that tkinter import will fail on win_amd64. So I should refactor code where tkinter is required.

Owner

  • Login: AdrienPlacais
  • Kind: user

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "CythonOnPyPi"
abstract: A sandbox for CI testing.
version: 1.2.14
date-released: '2025-01-30'
authors:
  - family-names: Plaçais
    given-names: Adrien
    orcid: "https://orcid.org/0000-0001-6840-1685"
identifiers:
  - description: This is the article that presented the code.
    type: doi
    value: "10.0000/nan.00000000"
license: MIT
repository-code: "https://github.com/AdrienPlacais/CythonOnPyPi"

GitHub Events

Total
  • Delete event: 1
  • Public event: 1
  • Push event: 86
  • Pull request event: 2
  • Create event: 59
Last Year
  • Delete event: 1
  • Public event: 1
  • Push event: 86
  • Pull request event: 2
  • Create event: 59

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • pre-commit-ci[bot] (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
pyproject.toml pypi
  • Cython >=3.0.10, <4.0.0
  • numpy >=2.0.1, <3.0.0
  • setuptools >=64.0.0
setup.py pypi
.github/workflows/cd.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/cibuildwheel v2.22.0 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/update_citation.yml actions
  • actions/checkout v4 composite
  • ad-m/github-push-action master composite