Table of Contents generated with DocToc
The template is used to create Python project. All Python projects must follow the conventions in the template. Calling for exceptions must be brought up in the engineering team.
The template doesn't have API docs. For web service, please include API docs here, whether it's auto-generated or hand-written. For auto-generated API docs, you can also give instructions on the build process.
The template follows project convention doc.
The template project is in alpha status.
Below we describe the conventions or tools specific to Python project.
We use pipenv to manage local development environment, as well as syncing with other collaborators and GitHub. See https://github.com/caicloud/engineering/blob/master/guidelines/python.md for more details about Python versions as well as this tool.
To get started, install pipenv first, cd to the root of your project, and type:
pipenv installAnd then run:
pipenv shellto enable local dependency shell.
.
├── .github
│ ├── ISSUE_TEMPLATE.md
│ └── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── CHANGELOG.md
├── CODEOWNERS
├── Dockerfile
├── Pipfile
├── Pipfile.lock
└── README.md
A brief description of the layout:
.githubhas two template files for creating PR and issue. Please see the files for more details..gitignorevaries per project, but all projects need to ignorebindirectory.CHANGELOG.mdcontains auto-generated changelog information.CODEOWNERScontains owners of the project.Dockerfileis the docker file for building imagePipfileis for specifying dependencies, managed and updated bypipenvPipfile.lockis for locking down dependencies, managed and updated bypipenvREADME.mdis a detailed description of the project.