findhere 0.1.5

Locate paths using relative path names locally and in the Cloud.

findhere

Overview

findhere provides functions that simplify using relative paths in your Python project.

Main Features

Installation

pip install findhere

Usage

In the init.py of the main repository, add:

import os
import pkg_resources

PROJECT_ROOT = os.path.abspath(
    pkg_resources.resource_filename("${1:project_name}", '..')) \
    if 'PROJECT_ROOT' not in os.environ else os.environ['PROJECT_ROOT']
os.environ['PROJECT_ROOT'] = PROJECT_ROOT

os.environ['CLOUD_ROOT'] = f"gs://{os.path.basename(PROJECT_ROOT)}" \
    if 'CLOUD_ROOT' not in os.environ else os.environ['CLOUD_ROOT']

If using datatracker,

os.environ['TRACKER_PATH'] = os.path.join(
    PROJECT_ROOT, os.path.basename(PROJECT_ROOT), 'db.json')

If versioneer has been added,

os.environ['VERSION'] = __version__

If defining directories for use with a script, use:

os.environ['VERSION'] = '0.1.1'
cloudir, localdir, filedir = init_directories(__file__)

Cite

Maintainer

Tarjinder Singh @ [e-mail]

Acknowledgements

Release Notes