Skip to main content

A tool for creating Boiler Plates.

Project description

boip

PyPI Versions license Supported Versions pytest code style

Japanese

boip is an abbreviation for Boiler Plate.

A library that generates code from code templates based on the answers to some questions.
I am a technical artist.
Therefore, the template to be added has a lot of code generation such as Maya related.

1. How to use.

1.1. pip install

python -m pip install boip

1.2. Run boip with CLI.

python -m boip

1.3. CD to the folder where you want to place the template.

cd "Folder path where you want to place the template."

1.4. Choose a template and answer your questions.

Image from Gyazo

1.5. Check the generated folder.

It is copied under cd with the last selected folder name.
Since I chose "Maya Qt-MVC" this time, a template of Maya + Qt + MVC pattern is generated.

Image from Gyazo

2. Add your own template.

Prepare a code template (BoipSet) in advance. Then specify the folder path where BoipSet is located with the -s flag.

python -m boip -s "Target folder path."

2.1. What is BoipSet?

The following two are set as a Boip Set.

  • After asking a question, a folder named "template" to use for replacement.
  • Configuration file named boip.yaml.

reference

2.1.1. How to write boip.yaml.

title: MayaQt-MVC # template name
convertExtensions: # distExtension srcExtension(The same extension is okay.)
  py: py
  ui: ui
question: # question list
  - name: tool_name # Name to use for replacement. Use with {Name} for stationery.
    message: "Tool name?" # Question.
    default: sampleWindow # Default Value.

  - name: maya_version
    message: "What version of Maya are you using?"
    default: 2020

2.1.2. How to make a template.

The folders under template will be copied. After that, the inside of {name} is converted by the answer to the question.
It is expected that automatic generation will be included in the future, but currently it is manual.

Example)In the case of "MayaQt-MVC" above.
I have two questions, {tool_name} and {maya_version}.

  • template
import sys

print("{tool_name}")
print("{maya_version}")
  • answer the questions.
Tool name? > sampleWindow
What version of Maya are you using? > 2020
  • After generation. The answer to the question will be converted to the following.
import sys

print("sampleWindow")
print("2020")

If you have a nice template, Please make a merge request!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Boip-0.0.2.tar.gz (11.7 kB view hashes)

Uploaded source

Built Distribution

Boip-0.0.2-py2-none-any.whl (13.7 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page