pythonpackageworkshop

Workshop of Packaging and Publishing Local Python Codes

https://github.com/fjying/pythonpackageworkshop

Science Score: 49.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Workshop of Packaging and Publishing Local Python Codes

Basic Info
  • Host: GitHub
  • Owner: fjying
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 718 KB
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 5
Created about 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

DOI

How to Package and Publish Your Python Codes

This workshop gives the overview of how to prepare all the documentation and codes to package and publish your python codes.

Create and Activate New Package Environment to Manage Packages

Choose either Conda Environment or Python Environment

Conda Envirionment

conda create -n pythonpackageworkshop python=3.9 conda activate pythonpackageworkshop ** **### Python Environment mkdir ~/packageenvs cd ~/packageenvs python -m venv pythonpackageworkshop source pythonpackageworkshop/bin/activate

Change Directory to the Repo Folder

Change directory to the folder of the repo PythonPackageWorkshop cd <.../PythonPackageWorkshop>

Install Package named packageworkshop and its dependencies

pip install -e .

Usage

```python import numpy as np from packageworkshop.rescale import rescale

rescales over 0 to 1

rescale(np.linspace(0, 100, 5)) ```

License

License

Owner

  • Name: Junying (Alice) Fang
  • Login: fjying
  • Kind: user

GitHub Events

Total
  • Watch event: 5
  • Push event: 2
Last Year
  • Watch event: 5
  • Push event: 2

Dependencies

pyproject.toml pypi