API Documentation


codetopackage

create_package

codetopackage.create_package.create_package(PackageReadme=True, PackageTargetDirectory='.', PackageSourceDirectory='.', PackageName='', PackageAuthor='', PackageDataFileTypes=[], PackageDataFolders=[], PackageAuthorEmail='', PackageInstallRequires=[], IncludeInAPI=[], PackageLicense='', PackageURL='', PackageTests=True, CreateDocs=True, InitAsGit=False, ConnectRemoteGitRepository='', CheckArguments=False, PrintExtra=False)[source]

Used to create a python package skeleton, should come out of the box with some bare documentation and be installable/ready to be pip installable.

Parameters

  • PackageReadme (bool) – If True, a barebones README is created in the base package directory.

  • PackageTargetDirectory (str) – The path/name of the save location for your package

  • PackageSourceDirectory (str) – The path/name of the folder containing your code

  • PackageName (str) – What you want the name of your package to be

  • PackageAuthor (str) – Your name (for docs)

  • PackageDataFileTypes (list) – List of data file extensions (e.g. txt, dat) for any data files in your code directory

  • PackageDataFolders (list) – List of data folders you need included in your package

  • PackageAuthorEmail (str) – Author e-mail address for docs

  • PackageInstallRequires (list) – By default this package will guess what remote dependencies exist from the code itself, this will overwrite that.

  • IncludeInAPI (list) – List of your modules you want to run autodoc on (and therefore should be documented so that autodoc can read them)

  • PackageLicense (str) – Your package license (for docs)

  • PackageURL (str) – If your package has a website (for docs)

  • PackageTests (bool) – If True, a test script is set up for your package (that you should then edit.)

  • CreateDocs (bool) – If True, barebones documentation is created for a readthedocs page.

  • InitAsGit (bool) – If True, the new package directory is initialized as a git repository

  • ConnectRemoteGitRepository (str) – A remote git repository to connect your local repo to, and adds it to docs install

  • CheckArguments (bool) – if true, checks the arguments with conditions written in the function if false, ignores those conditions

  • PrintExtra (int) – if greater than 0, prints addional information about the function if 0, function is expected to print nothing to console