zeitkapsel-api


Namezeitkapsel-api JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-07-30 11:13:00
maintainerNone
docs_urlNone
authorYour Name
requires_python<4.0,>=3.11
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # my-app

## Installation

Install the LangChain CLI if you haven't yet

```bash
pip install -U langchain-cli
```

## Adding packages

```bash
# adding packages from 
# https://github.com/langchain-ai/langchain/tree/master/templates
langchain app add $PROJECT_NAME

# adding custom GitHub repo packages
langchain app add --repo $OWNER/$REPO
# or with whole git string (supports other git providers):
# langchain app add git+https://github.com/hwchase17/chain-of-verification

# with a custom api mount point (defaults to `/{package_name}`)
langchain app add $PROJECT_NAME --api_path=/my/custom/path/rag
```

Note: you remove packages by their api path

```bash
langchain app remove my/custom/path/rag
```

## Setup LangSmith (Optional)
LangSmith will help us trace, monitor and debug LangChain applications. 
LangSmith is currently in private beta, you can sign up [here](https://smith.langchain.com/). 
If you don't have access, you can skip this section


```shell
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
export LANGCHAIN_PROJECT=<your-project>  # if not specified, defaults to "default"
```

## Launch LangServe

```bash
langchain serve
```

## Running in Docker

This project folder includes a Dockerfile that allows you to easily build and host your LangServe app.

### Building the Image

To build the image, you simply:

```shell
docker build . -t my-langserve-app
```

If you tag your image with something other than `my-langserve-app`,
note it for use in the next step.

### Running the Image Locally

To run the image, you'll need to include any environment variables
necessary for your application.

In the below example, we inject the `OPENAI_API_KEY` environment
variable with the value set in my local environment
(`$OPENAI_API_KEY`)

We also expose port 8080 with the `-p 8080:8080` option.

```shell
docker run -e OPENAI_API_KEY=$OPENAI_API_KEY -p 8080:8080 my-langserve-app
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "zeitkapsel-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/63/06/0bd74642c477b84ad74db965b0a877aabb1c4393b039030ae54c2fa77d7c/zeitkapsel_api-0.1.0.tar.gz",
    "platform": null,
    "description": "# my-app\n\n## Installation\n\nInstall the LangChain CLI if you haven't yet\n\n```bash\npip install -U langchain-cli\n```\n\n## Adding packages\n\n```bash\n# adding packages from \n# https://github.com/langchain-ai/langchain/tree/master/templates\nlangchain app add $PROJECT_NAME\n\n# adding custom GitHub repo packages\nlangchain app add --repo $OWNER/$REPO\n# or with whole git string (supports other git providers):\n# langchain app add git+https://github.com/hwchase17/chain-of-verification\n\n# with a custom api mount point (defaults to `/{package_name}`)\nlangchain app add $PROJECT_NAME --api_path=/my/custom/path/rag\n```\n\nNote: you remove packages by their api path\n\n```bash\nlangchain app remove my/custom/path/rag\n```\n\n## Setup LangSmith (Optional)\nLangSmith will help us trace, monitor and debug LangChain applications. \nLangSmith is currently in private beta, you can sign up [here](https://smith.langchain.com/). \nIf you don't have access, you can skip this section\n\n\n```shell\nexport LANGCHAIN_TRACING_V2=true\nexport LANGCHAIN_API_KEY=<your-api-key>\nexport LANGCHAIN_PROJECT=<your-project>  # if not specified, defaults to \"default\"\n```\n\n## Launch LangServe\n\n```bash\nlangchain serve\n```\n\n## Running in Docker\n\nThis project folder includes a Dockerfile that allows you to easily build and host your LangServe app.\n\n### Building the Image\n\nTo build the image, you simply:\n\n```shell\ndocker build . -t my-langserve-app\n```\n\nIf you tag your image with something other than `my-langserve-app`,\nnote it for use in the next step.\n\n### Running the Image Locally\n\nTo run the image, you'll need to include any environment variables\nnecessary for your application.\n\nIn the below example, we inject the `OPENAI_API_KEY` environment\nvariable with the value set in my local environment\n(`$OPENAI_API_KEY`)\n\nWe also expose port 8080 with the `-p 8080:8080` option.\n\n```shell\ndocker run -e OPENAI_API_KEY=$OPENAI_API_KEY -p 8080:8080 my-langserve-app\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e20648c77411bd46e0ff811a783c39fd463f679a017b6404bb10bc6688c28d75",
                "md5": "28b6d8ad0bba9db8eb5b613a7a2fdb54",
                "sha256": "3a59ef51b5cbf003b497afab7d540d3454fbb3aae9f7f8c1ae6435bb753a6a9e"
            },
            "downloads": -1,
            "filename": "zeitkapsel_api-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "28b6d8ad0bba9db8eb5b613a7a2fdb54",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 7388,
            "upload_time": "2024-07-30T11:12:58",
            "upload_time_iso_8601": "2024-07-30T11:12:58.284530Z",
            "url": "https://files.pythonhosted.org/packages/e2/06/48c77411bd46e0ff811a783c39fd463f679a017b6404bb10bc6688c28d75/zeitkapsel_api-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "63060bd74642c477b84ad74db965b0a877aabb1c4393b039030ae54c2fa77d7c",
                "md5": "043e74157010072953e1280bbb55b96f",
                "sha256": "4120dc6890b4833f4466b56549f183baa069375d21cbc03d6212527ca7532c17"
            },
            "downloads": -1,
            "filename": "zeitkapsel_api-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "043e74157010072953e1280bbb55b96f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 6422,
            "upload_time": "2024-07-30T11:13:00",
            "upload_time_iso_8601": "2024-07-30T11:13:00.338322Z",
            "url": "https://files.pythonhosted.org/packages/63/06/0bd74642c477b84ad74db965b0a877aabb1c4393b039030ae54c2fa77d7c/zeitkapsel_api-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-30 11:13:00",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "zeitkapsel-api"
}
        
Elapsed time: 1.10586s