Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Add Makefile, setup.py, Pipfile, and configuration files #9

Merged
merged 3 commits into from
Nov 28, 2018
Merged

Conversation

paoptu023
Copy link
Contributor

@paoptu023 paoptu023 commented Nov 26, 2018

Description of changes:

  • Add necessary files based on common Python project structure.
    • .pylintrc - Pylint configuration file.
    • MANIFEST.in - defines the list of files to include in the distribution.
    • Makefile - defines convenient commands for development.
    • Pipfile - declares abstract dependencies, used by Pipenv.
    • Pipfile.lock - declares dependencies with pinned versions for environment reproducibility.
    • serverlessrepo/__version__.py - defines package version and meta-data.
    • setup.cfg - Setup configuration file.
    • setup.py - Setup script to describe module distribution.
    • tox.ini - Tox configuration file to run tests against multiple Python versions.
  • You can skip .pylintrc and Pipfile.lock as they are auto generated. The only customizations in .pylintrc are:
    • Changed the max-line-length to 120.
    • Disabled linter for useless-object-inheritance, unused-argument, too-many-instance-attributes.
  • Tested packaging and publishing the module to TestPyPI, and I could successfully install it through pip.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@paoptu023 paoptu023 force-pushed the setup branch 3 times, most recently from 7a36073 to 0c2c017 Compare November 26, 2018 18:40
)
__url__ = 'https://github.com/awslabs/aws-serverlessrepo-python'
__author__ = 'Amazon Web Services'
__author_email__ = '[email protected]'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we want to use this email.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have an official email to use for interacting with external customers?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SAM does, but I think this is the first pypi project for SAR, which means this is likely the first time we've needed something like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put a placeholder as the team email, we can change it later on.

Pipfile Show resolved Hide resolved
setup.py Show resolved Hide resolved
setup.py Show resolved Hide resolved
Copy link

@keetonian keetonian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving provided a better email alias is used for SAR open source projects.

Makefile Outdated Show resolved Hide resolved
@paoptu023 paoptu023 merged commit b0638bc into master Nov 28, 2018
@paoptu023 paoptu023 deleted the setup branch November 28, 2018 21:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants