<p align="center"><img alt="Naas Logo" src="https://i.imgur.com/ZpcvnKi.jpg")
"></p>
## :sparkles: Welcome to Naas!
Notebooks as a service (Naas) is an open source platform that allows anyone touching data (business analysts, scientists and engineers) to create powerful data engines combining automation, analytics and AI from the comfort of their Jupyter notebooks.
Naas is an attempt to propose an alternative to Google Colab, powered by the community.
In addition to Google Colab, Naas platform upgrade notebooks with with 3 low-code layers: features, drivers, templates.
- **Templates** enable the user to create automated data jobs and reports in minutes.
- **Drivers** act as connectors to push and/or pull data from databases, APIs, and Machine Learning algorithms and more.
- **Features** transform Jupyter in a production ready environment with scheduling, asset sharing, and notifications.
## 🚀 Quick Start
Try all of Naas's features for free using -- [Naas cloud](https://app.naas.ai/hub/login) -- a stable environment, without having to install anything.
## ⚙️ Installation
Check out our step by step guide on how to [set up Naas locally.](https://docs.naas.ai/install-locally#run-locally)
<!-- ## ⚙️ Installation
### Install only Naas
`pip3 install naas`
### Install Naas with drivers
`pip3 install 'naas[full]'`
## :hourglass: Run locally
### Requirements
- Docker
- Make (Not needed on windows and not needed on Linux/MacOS if you prefer to use `docker-compose` directly).
### Run
**Linux / MacOS**
```bash
make
```
Then you can go on http://localhost:8888/lab?token=naas
**Windows**
You just need to double click on the file `windows_start.bat`, this will open a terminal, start naas and open your browser on http://localhost:8888/lab?token=naas.
## 🛑 Stop
**Linux / MacOS**
```bash
make stop
```
or if you want to delete the container as well you can run
```bash
make down
```
**Windows**
Double click on `windows_stop.bat`
## 📦 Build
You don't really have to run this, unless you changed something related to the `Dockerfile.dev`. The build process is done automatically when running naas (`make` or `make run`) if it never happened before.
**Linux / MacOS**
```bash
make build
```
### Open a shell in the container (root)
**Linux / MacOS**
```bash
make sh
```
### File structure for local development
When you land in your freshly started naas, on the left you should see a file structure like this:
```
.
├── awesome-notebooks
├── file_sharing
├── drivers
├── naas
└── Welcome_to_Naas.ipynb
```
When naas is starting, it will automatically mount `../drivers` and `../awesome-notebooks` in your home directory of your naas. This means that if these directories does not exists on your machine it will create them and `git clone` [naas drivers](https://github.com/jupyter-naas/drivers) in `../drivers` and [awesome-notebooks](https://github.com/jupyter-naas/awesome-notebooks) in `../awesome-notebooks`.
`naas` folder corespond to `.` directory on your machine (where naas project is cloned).
`file_sharing` directory is a folder created next to `./naas` to allow easy file sharing between your computer and naas container. Every file that you will drop in this directory, either from naas or from your computer will be accesible on both naas and your machine.
`Welcome_to_Naas.ipynb` is our welcoming notebook to get you a place to start your journey.
### Api documentation
We have a WIP documentation in swagger.
`http://127.0.0.1:5000/swagger/`
### Live reload
If you do change in naas code, the server will live reload.
If you use naas in a notebook restart the kernel to get the changes.
### Naas Manager
Open Naas manager outsite of jupyter context :
`http://localhost:5000/naas`
## Run test
Open Jupyterlab
click on `+` to open Launcher
Open Shell
Go the right directory `cd naas`
Run it in the shell `pytest -x` to test your code
Each Change you do from your IDE or from jupyter in the Naas folder is live reloaded
If you test naas feature inside a notebook reload your kernel between changes.
Same for the manager page you have to reload the Page to see the changes.
To go faster you can use `isolated Manager` to reload only manager and not full jupyterlab
## Check lint
`python -m black naas` format better
`python -m flake8 naas` check if any left error
## Publish
You can commit from jupyter or from your local IDE, code of Naas is sync between docker machine and your computer
this auto publish by github action on main branch -->
## ❤️ Contributing
We value all kinds of contributions - not just code. We are paticularly motivated to support new contributors and people who are looking to learn and develop their skills.
Please read our [contibuting guidelines](https://docs.naas.ai/contributing-to-naas) on how to get started.
## 🤔 Community Support
The naas [documentation](https://docs.naas.ai/) is a great place to start and to get answers for general questions.
- [Slack](https://join.slack.com/t/naas-club/shared_invite/zt-1970s5rie-dXXkigAdEJYc~LPdQIEaLA) (Live Discussions)
- [GitHub Issues](https://github.com/jupyter-naas/naas/issues/new) (Report Bugs)
- [GitHub Discussions](https://github.com/jupyter-naas/naas/discussions) (Questions, Feature Requests)
- [Twitter](https://twitter.com/JupyterNaas) (Latest News)
- [YouTube](https://www.youtube.com/c/naas-ai) (Video Tutorials)
- [Previous Community calls](https://naas-official.notion.site/3450f449df704f008c82004fd61f69ce?v=059be6a284e740e5b1013a57812a17f0) (Video call discussions with the naas team & other contributors.)
- [Naas's community page](https://www.notion.so/naas-official/Naas-Official-8150e2c35f9248049c48d3fe021b49bb) (To know more)
## :page_with_curl: License
The project is licensed under [AGPL-3.0](https://opensource.org/licenses/AGPL-3.0)
<!-- ## Supporters:
<p>
<a href="http://sentry.com" title="Redirect to Sentry">
<img width="200px" src="https://raw.githubusercontent.com/jupyter-naas/naas/main/images/sentry.svg" alt="Sentry" />
</a>
<a href="https://gitbook.com" title="Redirect to Gitbook">
<img width="200px" src="https://raw.githubusercontent.com/jupyter-naas/naas/main/images/gitbook.svg" alt="Gitbooks" />
</a>
</p>
**Authors:** [Jeremy Ravenel](https://github.com/jravenel), [Maxime Jublou](https://github.com/Dr0p42), [Martin Donadieu](https://github.com/riderx) -->
Raw data
{
"_id": null,
"home_page": "https://github.com/cashstory/naas",
"name": "naas",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Maxime Jublou",
"author_email": "devops@cashstory.com",
"download_url": "https://files.pythonhosted.org/packages/98/80/5d89c6ded8d058850e4ba765a7fc9464de4f27c319437427cdf7abe7d107/naas-2.14.7.tar.gz",
"platform": null,
"description": "<p align=\"center\"><img alt=\"Naas Logo\" src=\"https://i.imgur.com/ZpcvnKi.jpg\")\n\"></p>\n\n\n\n## :sparkles: Welcome to Naas!\n\nNotebooks as a service (Naas) is an open source platform that allows anyone touching data (business analysts, scientists and engineers) to create powerful data engines combining automation, analytics and AI from the comfort of their Jupyter notebooks.\n\nNaas is an attempt to propose an alternative to Google Colab, powered by the community.\n\nIn addition to Google Colab, Naas platform upgrade notebooks with with 3 low-code layers: features, drivers, templates.\n\n- **Templates** enable the user to create automated data jobs and reports in minutes.\n- **Drivers** act as connectors to push and/or pull data from databases, APIs, and Machine Learning algorithms and more.\n- **Features** transform Jupyter in a production ready environment with scheduling, asset sharing, and notifications.\n\n\n\n## \ud83d\ude80 Quick Start\n\nTry all of Naas's features for free using -- [Naas cloud](https://app.naas.ai/hub/login) -- a stable environment, without having to install anything.\n\n \n## \u2699\ufe0f Installation\n \nCheck out our step by step guide on how to [set up Naas locally.](https://docs.naas.ai/install-locally#run-locally)\n\n<!-- ## \u2699\ufe0f Installation\n\n### Install only Naas\n\n`pip3 install naas`\n\n### Install Naas with drivers\n\n`pip3 install 'naas[full]'`\n\n## :hourglass: Run locally\n\n### Requirements\n\n- Docker\n- Make (Not needed on windows and not needed on Linux/MacOS if you prefer to use `docker-compose` directly).\n\n### Run\n\n**Linux / MacOS**\n\n```bash\nmake\n```\n\nThen you can go on http://localhost:8888/lab?token=naas\n\n**Windows**\n\nYou just need to double click on the file `windows_start.bat`, this will open a terminal, start naas and open your browser on http://localhost:8888/lab?token=naas.\n\n## \ud83d\uded1 Stop\n\n**Linux / MacOS**\n\n```bash\nmake stop\n```\nor if you want to delete the container as well you can run\n\n```bash\nmake down\n```\n\n**Windows**\n\nDouble click on `windows_stop.bat`\n\n## \ud83d\udce6 Build\n\nYou don't really have to run this, unless you changed something related to the `Dockerfile.dev`. The build process is done automatically when running naas (`make` or `make run`) if it never happened before.\n\n**Linux / MacOS**\n\n```bash\nmake build\n```\n\n### Open a shell in the container (root)\n\n**Linux / MacOS**\n\n```bash\nmake sh\n```\n\n### File structure for local development\n\nWhen you land in your freshly started naas, on the left you should see a file structure like this:\n\n```\n.\n\u251c\u2500\u2500 awesome-notebooks\n\u251c\u2500\u2500 file_sharing\n\u251c\u2500\u2500 drivers\n\u251c\u2500\u2500 naas\n\u2514\u2500\u2500 Welcome_to_Naas.ipynb\n```\n\nWhen naas is starting, it will automatically mount `../drivers` and `../awesome-notebooks` in your home directory of your naas. This means that if these directories does not exists on your machine it will create them and `git clone` [naas drivers](https://github.com/jupyter-naas/drivers) in `../drivers` and [awesome-notebooks](https://github.com/jupyter-naas/awesome-notebooks) in `../awesome-notebooks`.\n\n`naas` folder corespond to `.` directory on your machine (where naas project is cloned).\n\n`file_sharing` directory is a folder created next to `./naas` to allow easy file sharing between your computer and naas container. Every file that you will drop in this directory, either from naas or from your computer will be accesible on both naas and your machine.\n\n`Welcome_to_Naas.ipynb` is our welcoming notebook to get you a place to start your journey.\n\n### Api documentation\n\nWe have a WIP documentation in swagger.\n\n`http://127.0.0.1:5000/swagger/`\n\n### Live reload \n\nIf you do change in naas code, the server will live reload.\n\nIf you use naas in a notebook restart the kernel to get the changes.\n\n### Naas Manager\nOpen Naas manager outsite of jupyter context :\n\n`http://localhost:5000/naas`\n\n## Run test \n\nOpen Jupyterlab\nclick on `+` to open Launcher\nOpen Shell\nGo the right directory `cd naas`\nRun it in the shell `pytest -x` to test your code\n\nEach Change you do from your IDE or from jupyter in the Naas folder is live reloaded\nIf you test naas feature inside a notebook reload your kernel between changes.\nSame for the manager page you have to reload the Page to see the changes.\nTo go faster you can use `isolated Manager` to reload only manager and not full jupyterlab\n\n## Check lint\n\n`python -m black naas` format better\n`python -m flake8 naas` check if any left error\n\n## Publish\n\nYou can commit from jupyter or from your local IDE, code of Naas is sync between docker machine and your computer\n\nthis auto publish by github action on main branch -->\n\n\n## \u2764\ufe0f Contributing\n\nWe value all kinds of contributions - not just code. We are paticularly motivated to support new contributors and people who are looking to learn and develop their skills.\n\n\nPlease read our [contibuting guidelines](https://docs.naas.ai/contributing-to-naas) on how to get started.\n\n\n## \ud83e\udd14 Community Support\n\nThe naas [documentation](https://docs.naas.ai/) is a great place to start and to get answers for general questions.\n\n- [Slack](https://join.slack.com/t/naas-club/shared_invite/zt-1970s5rie-dXXkigAdEJYc~LPdQIEaLA) (Live Discussions)\n- [GitHub Issues](https://github.com/jupyter-naas/naas/issues/new) (Report Bugs)\n- [GitHub Discussions](https://github.com/jupyter-naas/naas/discussions) (Questions, Feature Requests)\n- [Twitter](https://twitter.com/JupyterNaas) (Latest News)\n- [YouTube](https://www.youtube.com/c/naas-ai) (Video Tutorials)\n- [Previous Community calls](https://naas-official.notion.site/3450f449df704f008c82004fd61f69ce?v=059be6a284e740e5b1013a57812a17f0) (Video call discussions with the naas team & other contributors.)\n- [Naas's community page](https://www.notion.so/naas-official/Naas-Official-8150e2c35f9248049c48d3fe021b49bb) (To know more)\n\n## :page_with_curl: License\n\nThe project is licensed under [AGPL-3.0](https://opensource.org/licenses/AGPL-3.0)\n\n<!-- ## Supporters: \n<p>\n <a href=\"http://sentry.com\" title=\"Redirect to Sentry\">\n <img width=\"200px\" src=\"https://raw.githubusercontent.com/jupyter-naas/naas/main/images/sentry.svg\" alt=\"Sentry\" />\n </a>\n <a href=\"https://gitbook.com\" title=\"Redirect to Gitbook\">\n <img width=\"200px\" src=\"https://raw.githubusercontent.com/jupyter-naas/naas/main/images/gitbook.svg\" alt=\"Gitbooks\" />\n </a>\n</p>\n\n**Authors:** [Jeremy Ravenel](https://github.com/jravenel), [Maxime Jublou](https://github.com/Dr0p42), [Martin Donadieu](https://github.com/riderx) -->\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Scheduler system for notebooks",
"version": "2.14.7",
"project_urls": {
"Homepage": "https://github.com/cashstory/naas"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98805d89c6ded8d058850e4ba765a7fc9464de4f27c319437427cdf7abe7d107",
"md5": "ea41579abd4caee8c3d7e43375aed471",
"sha256": "736327c3207d3b66f5fc7095f5762a2c677bbfbad4b785454dd0b53c7ddc5809"
},
"downloads": -1,
"filename": "naas-2.14.7.tar.gz",
"has_sig": false,
"md5_digest": "ea41579abd4caee8c3d7e43375aed471",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 237946,
"upload_time": "2024-03-19T10:12:09",
"upload_time_iso_8601": "2024-03-19T10:12:09.589559Z",
"url": "https://files.pythonhosted.org/packages/98/80/5d89c6ded8d058850e4ba765a7fc9464de4f27c319437427cdf7abe7d107/naas-2.14.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 10:12:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cashstory",
"github_project": "naas",
"github_not_found": true,
"lcname": "naas"
}
JSON
