metadata.org

<!-- This file is generated automatically from metadata -->
<!-- File edits may be overwritten! -->

Project Specific Variables

General and Derived Variables

About

- Python Package Name: <<python-package-name>>
- Description: <<description>>
- Version: <<version>>
- Release Date: <<release-date>>
- Creation Date: <<creation-date>>
- License: <<license>>
- URL: <<repository-url>>
- Author: <<author>>
- Email: <<email>>
- Copyright: <<copyright>>
- References:
  - <<references>>
- Dependencies:
  - <<python-dependencies>>

Example Usage

Python

Command Line

help

<<command-line-interface>> --help
# Usage: <<command-line-interface>> [OPTIONS]

example usage

<<command-line-interface>>

Installation

https://github.com/janelia-python/python_setup

GNU/Linux

Python Code

The Python code in this library may be installed in any number of ways, chose one.

pip

python3 -m venv ~/venvs/<<python-package-name>>
source ~/venvs/<<python-package-name>>/bin/activate
pip install <<python-package-name>>

guix

Setup guix-janelia channel:

https://github.com/guix-janelia/guix-janelia

guix install <<guix-name>>

Windows

Python Code

The Python code in this library may be installed in any number of ways, chose one.

pip

python3 -m venv C:\venvs\<<python-package-name>>
C:\venvs\<<python-package-name>>\Scripts\activate
pip install <<python-package-name>>

Development

Install Guix

Install Guix

Clone Repository

git clone <<repository-url>>
cd <<repository-name>>

Make alias

source .metadata/.alias

Edit metadata.org

,make metadata-edits

Tangle metadata.org

,make metadata

Test Python package using ipython shell

,make ipython-shell
import <<python-package-name>>
exit

Test installation of Guix package

,make installed-shell
exit

Upload Python package to pypi

,make upload

Tangled Files

;; Local Variables: ;; eval: (setq after-save-hook nil) ;; eval: (setq org-confirm-babel-evaluate nil) ;; eval: (setq tangle-external-files nil) ;; eval: (setq python-package-dir “”) ;; End: