Skip to main content

Python-based development utilities

Project description

Introduction

Codeify is a pure Python code-generation utility for accelerating development in any platform / environment.

Codeify's code generator processes an input directory and produces an output directory with similar structure along with the aid of a provided specification file and Jinja templates for generated outputs.

Usage

Codeify should be used for development-only purposes. This should not be tied into any critical processes and should be seen only as a tool to speed up development.

Example

Using a sample input directory with the following files:

spec.yaml

---
structs:
    Account:
        fields:
            id: { type: int }
            name: { type: std::string }

    CheckingAccount:
        fields:
            amount: { type: double }
        _extends: Account

    SavingsAccount:
        fields:
            amount: { type: double }
            interest_rate: { type: double }
        _extends: Account

main.cpp.j2

{% for name, value in structs.items() %}
#include "{{ name }}.h"
{% endfor %}

int main()
{
    // TODO: Implement
    return 0;
}

class.j2

#pragma once

namespace structs
{
    class {{ class_name }}{% if class_data._extends %} : {{ class_data._extends }}{% endif %}
    {
    private:
        {% for field_name, field in class_data.fields.items() %}
        {{ field.type }} {{ field_name }}_;
        {% endfor %}
    public:
        {% for field_name, field in class_data.fields.items() %}
        {{ field.type }} get{{ pascal_name(field_name) }}() const
        {
            return {{ field_name }}_;
        }

        void set{{ pascal_name(field_name) }}({{ field.type }} && value)
        {
            {{ field_name }}_ = std::move(value);
        }

        {% endfor %}
    };
}

.codeify

---
ignore: [ spec.yaml, class.j2 ]
generate:
{% for name, data in structs.items() %}
    {{ name }}.h:
        input: class.j2
        data:
            class_name: {{ name }}
            class_data: {{ data }}
{% endfor %}

You can then run Codeify on the input directory ($INPUT) specifying both an output directory ($OUTPUT) and a specification file ($INPUT/spec.yaml):

codeify -i $INPUT -o $OUTPUT -s $INPUT/spec.yaml

Your output directory ($OUTPUT) should now contain the following files:

  • Account.h
  • CheckingAccount.h
  • SavingsAccount.h
  • main.cpp

The three Account header files are generated from class.j2 specified through a directory context file (.codeify). main.cpp was generated from main.cpp.j2. These were all generated with the use of the spec.yaml file providing the inputs.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

codeify-0.1-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file codeify-0.1-py3-none-any.whl.

File metadata

  • Download URL: codeify-0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.3

File hashes

Hashes for codeify-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d6696042024cfd6146925a22d8690d3cab6499e7bbb98c3bf9f584040bdbddd
MD5 ffd6509dce8c862cc30ee37b53a269b8
BLAKE2b-256 f131f0768bd17aac25c9daeeff59457ae42be94f3c13520c6ddbdce1f6af0631

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page