pyzify

Create self-contained executable Python "zipapps" using shiv.

https://github.com/caltechlibrary/pyzify

Science Score: 52.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
Organization caltechlibrary has institutional domain (www.library.caltech.edu)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.1%) to scientific vocabulary

Keywords

python python3 zipapp

Last synced: 4 months ago · JSON representation ·

Repository

Create self-contained executable Python "zipapps" using shiv.

Basic Info

Host: GitHub
Owner: caltechlibrary
License: other
Language: Makefile
Default Branch: main
Homepage:
Size: 62.5 KB

Statistics

Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Releases: 0

Topics

python python3 zipapp

Created over 4 years ago · Last pushed about 4 years ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Support Codemeta

Pyzify

A small program to create self-contained executable Python "zipapps" using shiv.

Introduction
Installation
Usage
Known issues and limitations
Getting help
Contributing
License
Authors and history
Acknowledgments

Introduction

Pyzify is a small program that does two things:

Creates a self-contained and executable Python zipapp from your Python source code. The resulting binary contains a bootstrap component and a pyz bundle of your application files with all the Python dependencies included. To run, the application only needs a Python interpreter of the right version on users' computers – users don't need to install other Python packages. It's almost like a regular compiled program!
Bundles the executable application into a zip archive suitable for distribution. The zip archive contains a README file with information about the application; the README is constructed using a template that you supply, letting you customize its contents.

Pyzify is uses shiv to do the real work. It adds some bootstrap code to test the version of Python at run-time and additional steps to create the zip archive for distribution.

Installation

Usage

Known issues and limitations

Getting help

If you find an issue, please submit it in the GitHub issue tracker for this repository.

Contributing

I would be happy to receive your help and participation with enhancing Handprint! Please visit the guidelines for contributing for some tips on getting started.

License

Software produced by the Caltech Library is Copyright © 2021 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the LICENSE file for more information.

Authors and history

Pyzify started as a script used by the author to create self-contained applications for Handprint and eprints2bags. It was spun out as its own project late in the year 2021.

Acknowledgments

This work was funded by the California Institute of Technology Library.

The vector artwork used as a starting point for the logo for this repository was created by Komkrit Noenpoempisut for the Noun Project. It is licensed under the Creative Commons Attribution 3.0 Unported license. The vector graphics was modified by Mike Hucka to change the color.

Owner

Name: Caltech Library
Login: caltechlibrary
Kind: organization
Email: helpdesk@library.caltech.edu
Location: Pasadena, CA 91125

Website: https://www.library.caltech.edu/
Repositories: 84
Profile: https://github.com/caltechlibrary

We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.

Citation (CITATION.cff)

# YAML 1.2
---
authors: 
  -
    affiliation: "Caltech Library"
    family-names: Hucka
    given-names: Michael
    orcid: "https://orcid.org/0000-0001-9105-5960"
cff-version: "1.1.0"
date-released: 
doi: 
keywords: 
  - Python
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/caltechlibrary/pyzify"
title: "pyzify: create self-contained executable Python 'pyz' zipapps"
version: "0.0.1"
...

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "description": "Create executable Python 'pyz' zipapps",
  "name": "pyzify",
  "codeRepository": "https://github.com/caltechlibrary/pyzify",
  "issueTracker": "https://github.com/caltechlibrary/pyzify/issues",
  "license": "https://github.com/caltechlibrary/pyzify/blob/main/LICENSE",
  "version": "0.0.1",
  "author": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Hucka",
      "affiliation": "California Institute of Technology Library",
      "email": "mhucka@library.caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    }
  ],
  "developmentStatus": "active",
  "downloadUrl": "https://github.com/caltechlibrary/pyzify/archive/main.zip",
  "keywords": [
    "software",
    "science"
  ],
  "maintainer": "https://orcid.org/0000-0001-9105-5960",
  "funder": {
    "@id": "https://doi.org/10.13039/100006961",
    "@type": "Organization",
    "name": "Caltech Library"
  }
}

GitHub Events

Total

Last Year

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0