packaging

Module introducing Python packaging and distribution

https://github.com/intersect-training/packaging

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 (13.9%) to scientific vocabulary

Keywords

citation packaging python
Last synced: 6 months ago · JSON representation ·

Repository

Module introducing Python packaging and distribution

Basic Info
Statistics
  • Stars: 4
  • Watchers: 2
  • Forks: 4
  • Open Issues: 5
  • Releases: 2
Topics
citation packaging python
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Packaging and Distribution Lesson

This repository contains a lesson on software packaging and distribution, based in Python.

It was initially written by Henry Schreiner and Kyle Niemeyer during the INTERSECT RSE Workshop held in August 2022 at Princeton University.

This repository builds a website that is live here.

Contributing

We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.

Please see the current list of issues for ideas for contributing to this repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter Contributing to a Project in Pro Git by Scott Chacon. Look for the tag good_first_issue. This indicates that the maintainers will welcome a pull request fixing this issue.

If you contribute to this lesson and would like to acknowledge specific funding support, please add it to the Funding section of the README below.

Dev Environment

This website is built using The Carpentries Workbench lesson infrastructure using R and the Pandoc markdown syntax. Please refer to the setup documentation to install necessary software to create a local dev environment.

Once the necessary software is installed, navigate to the project directory and input the following command in RStudio's console or R in the terminal to build the website locally and preview changes. When you edit files, they will automatically be rebuilt to your website.

r sandpaper::serve()

Author(s)

The contributing author(s) to this lesson are:

Maintainer(s)

Henry Schreiner

If you would like to serve as a maintainer please contact us.

Citation

To cite this lesson, please consult with CITATION.cff.

Funding

The INTERSECT project is supported by NSF awards 2017424 and 2017259.

Owner

  • Name: INTERSECT - RSE Training
  • Login: INTERSECT-training
  • Kind: organization

NSF funded project to develop and provide Research Software Engineering Training

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Please cite as:"
type: dataset
authors:
  - family-names: "Schreiner"
    given-names: "Henry"
    orcid: "https://orcid.org/0000-0002-7833-783X"
  - family-names: "Niemeyer"
    given-names: "Kyle"
    orcid: "https://orcid.org/0000-0003-4425-7097"
  - family-names: "Holland"
    given-names: "John Gerrard"
    orcid: "https://orcid.org/0000-0001-6845-8657"
  - family-names: "Dang"
    given-names: "George"
    orcid: "https://orcid.org/0009-0008-1566-8245"
  - family-names: "Restrepo"
    given-names: "Maria Isabel"
title: "INTERSECT: Packaging"
url: "https://github.com/INTERSECT-training/packaging"
date-released: "2024-07-17"

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
  • Delete event: 7
  • Issue comment event: 3
  • Push event: 37
  • Pull request review event: 7
  • Pull request event: 23
  • Fork event: 1
  • Create event: 8
Last Year
  • Issues event: 1
  • Watch event: 1
  • Delete event: 7
  • Issue comment event: 3
  • Push event: 37
  • Pull request review event: 7
  • Pull request event: 23
  • Fork event: 1
  • Create event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 13
  • Average time to close issues: N/A
  • Average time to close pull requests: 15 days
  • Total issue authors: 1
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.31
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 13
  • Average time to close issues: N/A
  • Average time to close pull requests: 15 days
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.31
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • hollandjg (39)
  • henryiii (3)
  • gtdang (1)
Pull Request Authors
  • hollandjg (41)
  • gtdang (7)
  • henryiii (6)
  • jhalverson (3)
  • MttArmstrong (2)
Top Labels
Issue Labels
maintenance (5) content (4) meta (2) bug (2) enhancement (1) don't do (1)
Pull Request Labels

Dependencies

Gemfile rubygems
  • github-pages >= 0 development
  • webrick >= 1.6.1
Gemfile.lock rubygems
  • activesupport 6.0.5.1
  • addressable 2.8.0
  • coffee-script 2.4.1
  • coffee-script-source 1.11.1
  • colorator 1.1.0
  • commonmarker 0.23.5
  • concurrent-ruby 1.1.10
  • dnsruby 1.61.9
  • em-websocket 0.5.3
  • ethon 0.15.0
  • eventmachine 1.2.7
  • execjs 2.8.1
  • faraday 2.5.1
  • faraday-net_http 3.0.0
  • ffi 1.15.5
  • forwardable-extended 2.6.0
  • gemoji 3.0.1
  • github-pages 227
  • github-pages-health-check 1.17.9
  • html-pipeline 2.14.2
  • http_parser.rb 0.8.0
  • i18n 0.9.5
  • jekyll 3.9.2
  • jekyll-avatar 0.7.0
  • jekyll-coffeescript 1.1.1
  • jekyll-commonmark 1.4.0
  • jekyll-commonmark-ghpages 0.2.0
  • jekyll-default-layout 0.1.4
  • jekyll-feed 0.15.1
  • jekyll-gist 1.5.0
  • jekyll-github-metadata 2.13.0
  • jekyll-include-cache 0.2.1
  • jekyll-mentions 1.6.0
  • jekyll-optional-front-matter 0.3.2
  • jekyll-paginate 1.1.0
  • jekyll-readme-index 0.3.0
  • jekyll-redirect-from 0.16.0
  • jekyll-relative-links 0.6.1
  • jekyll-remote-theme 0.4.3
  • jekyll-sass-converter 1.5.2
  • jekyll-seo-tag 2.8.0
  • jekyll-sitemap 1.4.0
  • jekyll-swiss 1.0.0
  • jekyll-theme-architect 0.2.0
  • jekyll-theme-cayman 0.2.0
  • jekyll-theme-dinky 0.2.0
  • jekyll-theme-hacker 0.2.0
  • jekyll-theme-leap-day 0.2.0
  • jekyll-theme-merlot 0.2.0
  • jekyll-theme-midnight 0.2.0
  • jekyll-theme-minimal 0.2.0
  • jekyll-theme-modernist 0.2.0
  • jekyll-theme-primer 0.6.0
  • jekyll-theme-slate 0.2.0
  • jekyll-theme-tactile 0.2.0
  • jekyll-theme-time-machine 0.2.0
  • jekyll-titles-from-headings 0.5.3
  • jekyll-watch 2.2.1
  • jemoji 0.12.0
  • kramdown 2.3.2
  • kramdown-parser-gfm 1.1.0
  • liquid 4.0.3
  • listen 3.7.1
  • mercenary 0.3.6
  • minima 2.5.1
  • minitest 5.16.2
  • nokogiri 1.13.8
  • octokit 4.25.1
  • pathutil 0.16.2
  • public_suffix 4.0.7
  • racc 1.6.0
  • rb-fsevent 0.11.1
  • rb-inotify 0.10.1
  • rexml 3.2.5
  • rouge 3.26.0
  • ruby2_keywords 0.0.5
  • rubyzip 2.3.2
  • safe_yaml 1.0.5
  • sass 3.7.4
  • sass-listen 4.0.0
  • sawyer 0.9.2
  • simpleidn 0.2.1
  • terminal-table 1.8.0
  • thread_safe 0.3.6
  • typhoeus 1.4.0
  • tzinfo 1.2.10
  • unf 0.1.4
  • unf_ext 0.0.8.2
  • unicode-display_width 1.8.0
  • webrick 1.7.0
  • zeitwerk 2.6.0
.github/workflows/pre-commit.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pre-commit/action v3.0.1 composite
.github/workflows/validate-citation.yml actions
  • actions/checkout v4 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite