Metadata-Version: 2.1
Name: jcloud
Version: 0.0.4
Summary: Simplify deploying and managing Jina projects on Jina Cloud
Home-page: https://github.com/jina-ai/jcloud
Author: Jina AI
Author-email: hello@jina.ai
License: Apache 2.0
Download-URL: https://github.com/jina-ai/jcloud/tags
Project-URL: Documentation, https://jcloud.jina.ai
Project-URL: Source, https://github.com/jina-ai/jcloud/
Project-URL: Tracker, https://github.com/jina-ai/jcloud/issues
Description: <p align="center">
        <br>
        <br>
        <br>
        <img src="placeholder?raw=true" alt="JCloud logo: the command line interface that simplifies deploying and managing Jina projects on Jina Cloud" width="200px">
        <br>
        <br>
        <br>
        <b>Simplify deploying and managing Jina projects on Jina Cloud</b>
        </p>
        
        <p align=center>
        <a href="https://pypi.org/project/jcloud/"><img alt="PyPI" src="https://img.shields.io/pypi/v/jcloud?label=PyPI&logo=pypi&logoColor=white&style=flat-square"></a>
        <a href="https://slack.jina.ai"><img src="https://img.shields.io/badge/Slack-2.7k%2B-blueviolet?logo=slack&amp;logoColor=white&style=flat-square"></a>
        </p>
        
        ☁️ **To the cloud!** - Smoothly deploy a local project as a cloud service. Radically easy, no brainfuck.
        
        🎯 **Cut to the chase** - One CLI with five commands to manage the lifecycle of your Jina projects.
        
        🎟️ **Early free access** - Sneak peek at our steathy cloud hosting platform. It leverages the latest cloud-native tech stack to host your Jina project, offers computational and storage resources. And it is free for now!
        
        
        ## Install
        
        ```bash
        pip install jcloud
        jc -h
        ```
        
        ## Get Started
        
        ### Login
        
        ```bash
        jc login
        ```
        
        You can use Google/Github account to register and login. Without login, you can do nothing.
        
        ### Deploy a Jina Flow
        
        In Jina's idiom, a Flow is a project. A Flow represents an end-to-end task such as indexing, searching, recommending, etc. In the sequel, we will use "project" and "Flow" interchangeably. 
        
        #### Deploy a single YAML Flow
        
        A Jina Flow can be as simple as a single YAML file, representing a Flow with all configs and executors in it. The simplest `toy.yml` looks like the following:
        
        ```yaml
        jtype: Flow
        executors: {}
        ```
        
        To make a single-YAML Flow in practice, it requires all Executors to be specified with `uses: jinahub+docker://MyExecutor` or `uses: docker://your_dockerhub_org/MyExecutor`. No more file dependency. The YAML itself is self-contained.
        
        
        To deploy it:
        
        ```bash
        jc deploy toy.yml
        ```
        
        
        Flow is succefully deployed when you see:
        
        <p align="center">
        <a href="https://jcloud.jina.ai"><img src="https://github.com/jina-ai/jcloud/blob/main/.github/README-img/deploy.svg?raw=true" width="40%"></a>
        </p>
        
        You will get an Flow ID, say `84b8b495df`. This ID is required to manage, view logs and remove the Flow.
        
        As this Flow is deployed with default gRPC gateway, you can use `jina.Client` to access it:
        
        ```python
        from jina import Client, Document
        
        c = Client(host='grpcs://84b8b495df.wolf.jina.ai')
        print(c.post('/', Document(text='hello')))
        ```
        
        #### Deploy a Flow from a folder
        
        You can also deploy a Jina Flow from a local folder:
        
        ```bash
        jc deploy /my/folder
        ```
        
        Note that `/my/folder` must contain a `flow.yml` that represents the Flow. Besides, it can contain sub-folders of Executor implementations. You can create an example project folder via `jc new`.
        
        
        ### View logs
        
        ```bash
        jc logs 84b8b495df
        ```
        
        ### Remove a Flow
        
        ```bash
        jc remove 84b8b495df
        ```
        
        ### Get the status of a Flow
        
        ```bash
        jc status 84b8b495df
        ```
        
        <p align="center">
        <a href="https://jcloud.jina.ai"><img src="https://github.com/jina-ai/jcloud/blob/main/.github/README-img/status.svg?raw=true" width="50%"></a>
        </p>
        
        
        ### List all Flows on the cloud
        
        ```bash
        jc list
        ```
        
        You can only see the Flows deployed by you.
        
        
        <!-- start support-pitch -->
        ## Support
        
        - Check out the [Learning Bootcamp](https://learn.jina.ai) to get started with DocArray.
        - Join our [Slack community](https://slack.jina.ai) and chat with other community members about ideas.
        - Join our [Engineering All Hands](https://youtube.com/playlist?list=PL3UBBWOUVhFYRUa_gpYYKBqEAkO4sxmne) meet-up to discuss your use case and learn Jina's new features.
            - **When?** The second Tuesday of every month
            - **Where?**
              Zoom ([see our public events calendar](https://calendar.google.com/calendar/embed?src=c_1t5ogfp2d45v8fit981j08mcm4%40group.calendar.google.com&ctz=Europe%2FBerlin)/[.ical](https://calendar.google.com/calendar/ical/c_1t5ogfp2d45v8fit981j08mcm4%40group.calendar.google.com/public/basic.ics))
              and [live stream on YouTube](https://youtube.com/c/jina-ai)
        - Subscribe to the latest video tutorials on our [YouTube channel](https://youtube.com/c/jina-ai)
        
        ## Join Us
        
        JCloud is backed by [Jina AI](https://jina.ai) and licensed under [Apache-2.0](./LICENSE). [We are actively hiring](https://jobs.jina.ai) AI engineers, solution engineers to build the next neural search ecosystem in open-source.
        
        <!-- end support-pitch -->
        
Keywords: jcloud neural-search serverless deployment devops mlops
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Unix Shell
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Provides-Extra: test
