Prompts

When you create a package, you are prompted to enter these values.

Templated Values

The following appear in various parts of your generated project.

full_name: Your full name.
email: Your email address.
github_username: Your GitHub username.
project_name: The name of your new Python package project. This is used in documentation, so spaces and any characters are fine here.
project_slug: The namespace of your Python package. This should be Python import-friendly. Typically, it is the slugified version of project_name. Note: your PyPi project and Travis links will use project_slug, so change those in the README afterwards.
project_short_description: A 1-sentence description of what your Python package does.
pypi_username: Your Python Package Index account username.
version: The starting version number of the package.

The following package configuration options set up different features for your project.

use_pytest: Whether to use pytest.
use_black: Whether to use black.
oasis_connection: Choose the Oasis connection of your preference for this project, pyArango or python-arango.
use_arangopipe: Whether to use arangopipe.
oasis_adapter: Choose the Oasis adapter to choose, the choices are: networkx-adapter Cupgraph-adapter pyg-adapter dgl-adapter
use_oasis: Whether to use the Oasis-Tool to connect to this service.
use_sphinx: Whether to use Sphinx.
create_author_file: Whether to create an authors file, or not
import_IMDB_Movie-Graph: Whether to import this pre build project, or not.
create_PyPI_package: Whether to import the basics needed for to create and upload a PyPI package
include_notebooks: Whether to include some explanatory Notebooks for the packages mentioned above.
open_source_license: Choose a license. Options: [1. MIT License, 2. BSD license, 3. ISC license, 4. Apache Software License 2.0, 5. GNU General Public License v3, 6. Not open source]