Frequently Asked Questions (FAQs)

Which Python versions are compatible with Projectify!?

Projectify! is compatible with Python 3.8 and above.

How can I customize the project structure?

You can customize the initial structure by modifying the configuration files generated in your project.

How can I add more features to the project?

You can add more features to the project by modifying the configuration files generated in your project. You can also add your own custom scripts and configurations to the project.

How can I contribute to the project?

You can contribute to the project by submitting a pull request on the GitHub repository.

How can I report a bug or request a feature?

You can report a bug or request a feature by opening an issue on the GitHub repository.

How can I contact the project maintainers?

You can contact the project maintainers by sending an email to npinoa.ai@gmail.com.

How can I get help with using Projectify!?

You can get help with using Projectify! by reading the documentation or opening an issue on the GitHub repository. You can also join the community on Discord for more support and discussions.

How can I contribute to the documentation?

You can contribute to the documentation by submitting a pull request on the GitHub repository. The documentation is written in Markdown and is located in the docs directory of the repository.

How can I install the project dependencies?

You can install the project dependencies by running the install_dependencies() function. This will install the dependencies listed in the requirements.txt file using uv inside a virtual environment if it exists. If a virtual environment does not exist, it will install the dependencies globally using pip.

How can I run the tests for the project?

You can run the tests for the project by running the run_tests() function. This will run the tests using pytest if the tests folder and the test configuration file exist.

How can I run the linter on the project codebase?

You can run the linter on the project codebase by running the run_linter() function. This will run the ruff linter on the project codebase.

How can I format the project codebase?

You can format the project codebase by running the format_code() function. This will format the project codebase using ruff with the --fix option. This will fix any formatting issues in the codebase and make it consistent with the project's style guide.

How can I generate the project documentation?

You can generate the project documentation by running the generate_docs() function. This will generate the project documentation using mkdocs. The documentation will be generated in the site directory of the project. You can view the documentation by opening the index.html file in a web browser.