serverless-python-starter

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

serverless-python-starter

★ 40 Open GitHub ↗

Python starter project for Serverless Framework

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Serverless Python Starter [![Seed Status](https://api.seed.run/serverless-stack/serverless-python-starter/stages/dev/build_badge)](https://console.seed.run/serverless-stack/serverless-python-starter)

A Python starter project for [Serverless Framework](https://serverless.com/framework/) with support for dependencies (using [virtualenv](https://pypi.python.org/pypi/virtualenv) & [serverless-python-requirements](https://github.com/UnitedIncome/serverless-python-requirements)) and tests (using [unittest](https://docs.python.org/2/library/unittest.html#module-unittest)).

### Demo

A demo version of this service is hosted on AWS - [`https://udshnoxw3k.execute-api.us-east-1.amazonaws.com/dev`](https://udshnoxw3k.execute-api.us-east-1.amazonaws.com/dev)

### Requirements

- [Install Python](https://www.python.org/downloads/release/python-363/)
- [Install Virtualenv](https://virtualenv.pypa.io/en/stable/installation/)
- [Install the Serverless Framework](https://serverless.com/framework/docs/providers/aws/guide/installation/)
- [Configure your AWS CLI](https://serverless.com/framework/docs/providers/aws/guide/credentials/)

### Installation

Create a new project

```sh
$ serverless install --url https://github.com/AnomalyInnovations/serverless-python-starter --name my-project
```

Create a virtual environment for your project

```sh
$ cd my-project
$ virtualenv -p /usr/bin/python3.6 venv
```

Activate the virtual environment

```sh
$ source venv/bin/activate
```

Install Serverless plugin: serverless-python-requirements

```sh
$ npm install
```

### Usage

Install a Python dependency (for example, [Requests](http://docs.python-requests.org/en/master/))

```sh
$ pip install requests
```

Store a reference to your dependencies

```sh
$ pip freeze > requirements.txt
```

Re-install your dependencies from your requirements

```sh
$ pip install -r requirements.txt
```

Invoke a function locally

```
$ serverless invoke local -f hello
```

Run your tests
```
$ python -m unittest discover -s tests
```

Deactivate your virtual environment

```sh
$ deactivate
```

### Deploying

Deploy your project

```sh
$ serverless deploy
```

Deploy a single function

```sh
$ serverless deploy function --function hello
```

To compile non-pure Python modules, install [Docker](https://docs.docker.com/engine/installation/) and the [Lambda Docker Image](https://github.com/lambci/docker-lambda). Enable **dockerizePip** in **serverless.yml** and `serverless deploy` again.

```yml
# enable dockerize Pip
custom:
  pythonRequirements:
    dockerizePip: true
```

**Note**, if you are deploying using [SEED](https://seed.run), you don't need to enable **dockerizePip** or install Docker. [SEED](https://seed.run) does it automatically.

### Support

- Send us an [email](mailto:contact@anoma.ly) if you have any questions
- Open a [new issue](https://github.com/AnomalyInnovations/serverless-python-starter/issues/new) if you've found a bug or have some suggestions.
- Or submit a pull request!

### Maintainers

Maintained by Frank Wang ([@fanjiewang](https://twitter.com/fanjiewang)) & Jay V ([@jayair](https://twitter.com/jayair)). [**Subscribe to our newsletter**](http://eepurl.com/cEaBlf) for updates. Send us an [email](mailto:contact@anoma.ly) if you have any questions.

serverless-python-starter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README