Skip to content

Latest commit

 

History

History
126 lines (91 loc) · 5.37 KB

README.md

File metadata and controls

126 lines (91 loc) · 5.37 KB
Raw

This2That Toolkit

This2That, a toolkit for converting one entity to another

Design Principles:

  • Each function resolves one entity to one other entity
    • The input and output entities are not necessarily simple, but are individual objects
    • But they should be obvious, not vaguely defined
    • If entities are complex, intermediate this2that steps may occur within a given function
  • Each function may contain only the following lines of code:
    • Code required for the function
    • Validation for input (and possibly output) entities
    • Error Handling
    • Comments
  • Validation is minimal, present, and optional (validate=False)
    • Regex is the preferred method of validation, when appropriate
  • Errors are descriptive and concise
  • Occam's Razor wins
    • When something is unclear--whether entity format, process, or otherwise, the least complex wins

Table of Contents

  1. This2That Python API Wrapper
  2. Metadata

Getting Started

Prerequisites

Installation

There is no formal installation process at this time, but using git subtrees is strongly recommended. Unfortunately there is no 'helper' integration for git subtrees in VS Code, so using the actual git commands are necessary:

git subtree add --prefix tools/This2That https://github.com/epopisces/tools_This2That master --squash
git fetch https://github.com/epopisces/tools_This2That master

# Breaking the above down, the following command creates the subtree and the connection to the remote repo
'''
git subtree add --prefix <dest-path> <source-repo> <branch> --squash
    --prefix <path>         specify the destination folder (relative to current working directory).
    <source-repo>           the repository that is being pulled from
    <branch>                branch to be pulled (usually 'master', may be 'main' if more recently created in GitHub)
    --squash                optional but recommended command to discard the commit history of the source repo
'''
#The following command fetches the content of that repo so it will be available for use
'''
git fetch <source-repo> <branch>
    <source-repo>           the repository that is being pulled from
    <branch>                branch to be pulled (usually 'master', may be 'main' if more recently created in GitHub)
'''

But what if the remote tool repo gets updated? Pulling the latest changes is super easy, barely an inconvenience: just use the same command above with 'git subtree pull' instead of 'git subtree add':

git subtree pull --prefix tools/This2That https://github.com/epopisces/tools_This2That master --squash

Alternately git submodules can also be used; however, git submodules are not as easy to maintain and keep updated. The recommendation is only to use git submodules if the tools repo is also going to be developed as part of the project, instead of just used as a static library by the main project.

The differences between git subtrees and git submodules are described in depth in this article.

This2That Python Toolkit

this2that.py

Capabilities

  • Authentication against API
  • can do thing 1
  • can do thing 2

Usage

The below assumes you are using the repo as a subtree as described above. Note this will require creating a empty __init__.py file in the 'tools' folder if there is not one present already so Python's import function can traverse the directories to get to the tool.

import os
from tools.This2That import this2that as bbk

acct_email = os.getenv('this2that_email')        # Use environment variable by this name to store a username for the API user
acct_pass = os.getenv('this2that_pass')       # Use environment variable by this name to store a password for the API user
bb = bbk.BaseBrick(acct_email, acct_pass)

abbrev.{function-name}({parameters})

  • Required Arguments

    Variable Name Type Required? Description
    thing1 dict Required Dictionary containing things

  • Optional Argument

    Variable Name Type Required? Default Description
    thing2 bool Optional False Determines if a thing happens

Running the Tests

Explain how to run the automated tests

Release History

  • 0.1.0
    • The first proper release, signified by upload to FL Github
  • 0.0.1
    • Work in progress, local dev

Metadata

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under an MIT standard license - see the LICENSE.md file for details

Acknowledgments

  • epopisces created the project template and boilerplate code used for this project
  • Thanks to PurpleBooth & dbader for the README Template