Skip to main content

A brief description of your package

Project description

envmate

envmate is an interactive command-line tool designed to simplify the process of configuring environment variables for your Python projects. It provides a user-friendly interface to set up .env files for various Python frameworks such as Flask, Django, and FastAPI, as well as configure database connections, authentication systems, and other essential settings.

Features

  • Interactive Setup: Guides you through the process of setting up environment variables with an easy-to-use interactive prompt.
  • Support for Multiple Frameworks: Configure environment variables for Flask, Django, and FastAPI projects.
  • Database Configuration: Supports both SQL (PostgreSQL, MySQL) and NoSQL (MongoDB, Cassandra) databases.
  • Authentication Setup: Allows you to set up JWT or session-based authentication, including access and refresh tokens.
  • Custom Environment Variables: Add custom environment variables specific to your project's needs.
  • Configuration Templates: Save and reuse configuration templates to streamline the setup process for future projects.
  • Environment-specific Settings: Configure variables for different environments like development, testing, and production.

Installation

You can install envmate using pip:

pip install envmate

Usage

After installation, you can use the tool via the command line:

env-configurator

The tool will prompt you to select the Python framework you are using and guide you through setting up the necessary environment variables.

Example Workflow

$ env-configurator

Welcome to the Python Environment Configuration Tool!

What kind of Python stack are you using?
> Flask
  Django
  FastAPI

Which environment are you configuring?
> development
  testing
  production

Are you building an authentication system? (Y/n): Y

What type of authentication are you using?
> JWT
  Session-based

Do you need access and refresh tokens? (Y/n): Y

Will your application use email protocols? (y/N): N

Will your application use Redis? (y/N): N

Will your application use SQL databases? (Y/n): Y

Will your application use NoSQL databases? (y/N): Y

Will your application use Elasticsearch? (y/N): N

Flask environment:
> development
  production

Flask secret key: <generated_secret>
Enable debug mode? (y/N): Y

CORS origins: http://localhost:3000

Which NoSQL database are you using?
> MongoDB
  Cassandra

MongoDB URI: mongodb://localhost:27017

Configuration Summary:
FLASK_ENV=development
SECRET_KEY=<generated_secret>
DEBUG=True
CORS_ORIGINS=http://localhost:3000
MONGODB_URI=mongodb://localhost:27017

Here is the summary of your configuration. Do you want to write it to the .env file? (Y/n): Y
.env variables have been written successfully.
Do you want to save this configuration as a template? (y/N): N

Process completed successfully!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for more information on how to contribute to this project.

Issues

If you encounter any issues or have suggestions for improvements, please report them on the GitHub issue tracker.

Author

Developed by Harris Ahmad.

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

envmate-0.2.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

envmate-0.2.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file envmate-0.2.0.tar.gz.

File metadata

  • Download URL: envmate-0.2.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for envmate-0.2.0.tar.gz
Algorithm Hash digest
SHA256 80b1ab42ed319e01c0707353b8aaa65b2571d9d726714693531c7af5f4e70b0a
MD5 262d84d60f0b2ec6448a8ed31a8520a2
BLAKE2b-256 32b83fa09b28d5dabdac4ef36ce38ff531c3af14c454f05f0459667607b6429e

See more details on using hashes here.

File details

Details for the file envmate-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: envmate-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for envmate-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b94e3eb903890e485813499456bf134098d4ff309ea739d4b9769ba448483607
MD5 2672cd06c65e29606d76aa102a2dcd1c
BLAKE2b-256 28d558d8e2a0173148c90805835eeffb4590a8e74c76038ad9752e96c3ced05e

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