Skip to main content

The Scaffolding tool for Falconify

Project description

The Scaffolding tool for Falconify.

This scaffolding tool includes a set of commands that allows you to bootstrap your modules following the suggested structure for the Falconify template.

Scaffold usage:
Start a project: falconify bootstrap
Boot a module: falconify create-module Pricing or Pricing_Tier

This will create:

Bridging:

  • The Command Handler: - this will create a new directory under Application/Features and it will place the handler there. You don't need to modify anything here.

Port:

  • The Request Handler: - this will create a new directory under Application/Infrastructure/Port/Request and it will place the handler there. You don't need to modify anything here.
  • The Router: - this will create a new file and add it to the Application/Infrastructure/Port/Request/. You don't need to modify anything here for your general CRUD.
  • The Transformer: - this will create a new transformer under Application/Infrastructure/Port/Transformer. You will need to modify this file to implement your contract.

Adapter:

  • The Repository: - this will create a new file on Adapters/Repository. You will need to modify the methods (create / update) in this file to fulfil your data requirements

Domain:

  • The Model: - this will create a new file on Domain/Model. You will need to model your object in this file.
  • The Use Case: - this will create a new file on Domain/UseCases. You don't need to do much in this file, unless you're doing something out of the normal CRUD. But yes, your business logic should be implemented here.
    Once all of this is done, you can implement your route on Application/Main.py, by:

Importing your new route - found on Application/Infrastructure/Port/Request/Routes.py
To invoke the route by: Routes().define(self)

You're ready to consume.
This does not cater for migration. Falconify currently uses alembic to manage the migrations.

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

falconify-0.1.1.tar.gz (9.2 kB view details)

Uploaded Source

File details

Details for the file falconify-0.1.1.tar.gz.

File metadata

  • Download URL: falconify-0.1.1.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.4

File hashes

Hashes for falconify-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3a0333c35fdb571e678df6928af0e323da88f364547586f24892e22997f3ed77
MD5 5b97ac59de708d1a163588e92d1d62cf
BLAKE2b-256 91bf62c875bcb5ce0e67f6de1081c88133e3d72d6b8b39395fa5b23c2d6d7830

See more details on using hashes here.

Supported by

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