{"id":13942205,"url":"https://github.com/NeowayLabs/data-science-template","last_synced_at":"2025-07-20T05:32:21.691Z","repository":{"id":72148907,"uuid":"189412997","full_name":"NeowayLabs/data-science-template","owner":"NeowayLabs","description":"A template for Data Science projects with a solid Software Engineering Architecture","archived":false,"fork":false,"pushed_at":"2019-10-07T19:46:04.000Z","size":31,"stargazers_count":44,"open_issues_count":3,"forks_count":11,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-11-27T11:39:06.947Z","etag":null,"topics":["datascience","model","project","template"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NeowayLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-05-30T12:50:14.000Z","updated_at":"2024-05-27T19:10:31.000Z","dependencies_parsed_at":"2023-06-13T11:15:07.573Z","dependency_job_id":null,"html_url":"https://github.com/NeowayLabs/data-science-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NeowayLabs/data-science-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeowayLabs%2Fdata-science-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeowayLabs%2Fdata-science-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeowayLabs%2Fdata-science-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeowayLabs%2Fdata-science-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NeowayLabs","download_url":"https://codeload.github.com/NeowayLabs/data-science-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeowayLabs%2Fdata-science-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266071519,"owners_count":23871940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["datascience","model","project","template"],"created_at":"2024-08-08T02:01:45.037Z","updated_at":"2025-07-20T05:32:16.674Z","avatar_url":"https://github.com/NeowayLabs.png","language":"Makefile","funding_links":[],"categories":["Makefile"],"sub_categories":[],"readme":"# Data Science Template\n\n[![Build Status](https://travis-ci.org/NeowayLabs/data-science-template.svg?branch=master)](https://travis-ci.org/NeowayLabs/data-science-template)\n\nThis repository contains a project creation tool for Data Science\nmodels. The main usage is quite simple, but we have a lot of features\nworking **OUT OF THE BOX**:\n\n+ `Dockerfile` template;\n+ Unit-tests architecture with coverage report;\n+ Makefile for project management and Docker abstraction;\n+ Python software distribution via `setup.py`;\n+ Multiple releases formats into `/dist`: `.tar.gz`, `.egg` and `.whl`;\n+ Documentation: Project Specification \u0026\u0026 Model Report;\n+ Notebook template for data analysis;\n+ Multiple linters to help catching bugs during development:\n  + security: **bandit**;\n  + style: **flake8**;\n  + typing: **mypy**;\n+ CI/CD configuration with 3 stages: test, build and pages\n  + tests: run unit-tests;\n  + build: build docker image and populate `/dist`;\n  + pages: build html documentation using\n  [Sphinx](http://www.sphinx-doc.org/en/master/) and publish using\n  [Read The Docs](https://readthedocs.org/);\n\n# Usage\n\nSo let's create a new model! You just need clone this repository and\nuse the bash script `create-model` as follow:\n\n``` bash\ngit clone git@github.com:NeowayLabs/data-science-template.git\ncd data_science_template\n./create-model ~/awesome-model\n```\n\nThe basic placeholders like `project name`, `python package name` are\nautomatically filled! If you have configured the git `user.name` and\n`git user.email` the system will assume to be equal as `author` and\n`email` and will replace these placeholders as well. The directory\ncreated will be initialized as a git repository, but you still need\nconfigure your remote url manually.\n\nThe `create-model` program will help you configure the remote printing\nsome instructions to do that correctly, keep **attention** to blue\nexclamation marks `[!]` on output of `create-model`. But basically you\nneed do two steps:\n\n1. Create a new project in [GitHub](https://github.com/).\n2. Get the ssh or https remote from it.\n\nYou can test the remote address executing a git clone command:\n\n```bash\ngit clone \u003cyour-repository-address-here\u003e\n```\n\nTo enable properly CI/CD functionality for your new repository you can\ndo the following:\n\n1. Go to [Travis CI](https://travis-ci.org/).\n2. Select your repository to use with Travis CI.\n[These instructions](https://docs.travis-ci.com/user/tutorial/#to-get-started-with-travis-ci)\nmay help.\n\n\nAfter this, update your git remote `origin` and do the\nfirst commit:\n\n``` bash\ncd ~/awesome-model\nmake check  # check if everything is ok and tests are passing\ngit add .\ngit commit -m \"Initial commit\" # Or your desired message\ngit remote add origin \u003cyour-repository-address-here\u003e\ngit push -u origin master\n```\n\n# Releasing Software\n\nYou can release a new version of your software with this command:\n\n```bash\nmake release VERSION=X.Y.Z\n```\n\nThat is all. That command will build the docker image, run the tests,\nlinters and if everything is ok: a new git tag will be created and\nbe pushed to GitHub.\n\n\n# Author\nNeoway @ Data Analytics Team\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNeowayLabs%2Fdata-science-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNeowayLabs%2Fdata-science-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNeowayLabs%2Fdata-science-template/lists"}