interphase 0.0.6

Package for genarating typescript interface with git submodule folder structure

Interphase - Bridging Backend and Frontend Development with Git Submodule

Introduction

Interphase is a powerful tool + git structure designed to streamline the collaboration between backend and frontend developers by facilitating the sharing of critical information, including types, example data, API URLs, and documentation. The core concept is to provide an interconnected platform that enables seamless communication between these two development environments, thereby reducing friction and enhancing productivity, thus bridging the gap between the two development repository.

Currently Available Support Packages

• Interphase - Python → Typescript
• Comming Soon - Go → Typescript

Requirements

Python >= 3.7

1. Installation

$ pip install Interphase

2. Quick Start

📁 Simple folder structure

📁  your_project
|
├──📁 types (requied)
|   |
│   └──📄api.d.ts (optional)
|
└──📄main.py

📄main.py

from Interphase import Interphase

ts = Interphase("./types")

userData = {
    "name": "John Doe",
    "age": 30,
    "email": "[e-mail]",
    "skills": ["Python", "TypeScript", "JavaScript"]
}

ts.write('api', 'UserData', userData)

📄 api.d.ts

export type UserData = {
    name: string;
    age: number;
    email: string;
    skills: string[];
}

3. Real Life Developer Usage

.gitmodules

[submodule "api"]
	path = api
	url = https://github.com/username/api.git

Frontend

📁 FrontEnd-repo
│
├──📁 api (git submodule)
│   │
│   ├──📄__init__.py
│   ├──📄setup.py
│   │
│   └──📁 types
│       │
│       └──📄 api.d.ts
│
├──📁 src
│   │
│   └──📄 (other frontend files, where /api/types are imported and used)
│   
├──📄 package.json
├──📄 .gitmodules (important)
└──📄 .gitignore

Backend

📁 Backend-repo
│
├──📁 api (git submodule)
│   │
│   ├──📄__init__.py
│   ├──📄setup.py
│   │
│   └──📁 types
│       │
│       └──📄 api.d.ts
│
├──📁 src
│   │
│   └──📄 (other backend files, where helps to create types for /api)
│   
├──📄 requirements.txt
├──📄 .gitmodules (important)
└──📄 .gitignore

4. Configuration

📄 /api/setup.py

config = Interphase("./types", d_ts=True) # base setup

📄 /api/__init__.py

from .setup import config as ts

5. API Reference

export types | interface

ts = Interphase("./types") 

# default is export enabled
ts.write('api', 'UserData', userData)
ts.write('api', 'UserData2', userData, export=False)

# default is type and interface can be enabled
ts.write('api', 'UserData3', userData, interface=True)
ts.write('api', 'UserData3', userData, export=False, interface=True)

export type UserData = {...}
type UserData2 = {...}

export interface UserData3 {...}
interface UserData3 {...}

base folder

# base directory can't be empty string
ts = Interphase("types") 
ts = Interphase("./types") 


# d.ts is defualt
# .ts can be enabled
ts = Interphase("./types", d_ts=False) 
ts.write('api', 'UserData', userData)

export type UserData = {...} // api.ts 

file name

# type name and file name can't be empty string
ts.write('api.ts', 'UserData', userData)
ts.write('api.d.ts', 'UserData', userData)


# d.ts is defualt
ts.write('api', 'UserData', userData)

7. FAQs

List and answer frequently asked questions users might have about your package.

8. Troubleshooting

Provide solutions to common issues users might encounter and how to resolve them.

9. Contributing

Encourage others to contribute to your project. Include guidelines for submitting bug reports, feature requests, and pull requests.

10. License

Specify the license under which your package is released.

---

Remember that your documentation should be clear, concise, and easy to follow. Use a consistent tone and style throughout, and consider using code snippets, diagrams, and examples to enhance understanding. Regularly update the documentation as your package evolves to ensure it remains accurate and helpful to your users.

Interphase

interface is not supported yet

defualt is export On default is type = need file name need type name need any data

base directory can be empty string d.ts is supported & it is defualt

dev

pip install --upgrade setuptools
pip install --upgrade build #python -m build

$ pip install -q build
$ python -m build

pyproject.toml https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html

dist/
    meowpkg-0.0.1.whl
    meowpkg-0.0.1.tar.gz

$ pip install dist/meowpkg-0.0.1.whl
$ pip install dist/meowpkg-0.0.1.tar.gz

upload to pypi

$ python -m twine upload --repository pypi dist/*

.

• tree-md
• dir2
  • file21.ext
  • file22.ext
  • file23.ext
• dir1
  • file11.ext
  • file12.ext
• file_in_root.ext
• README.md
• dir3