Release 0.0.7

.github/workflows/python-package.yml

@@ -1,20 +1,22 @@
-name: Integration and Unit Tests Type Infer
+name: Type Infer Tests Workflow
 
 on:
   push:
   pull_request:
     branches:
       - stable
       - staging
-
+    paths-ignore:
+      - 'docssrc/**'
+      - '**.md'
 
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.8,3.9]
+        python-version: [3.7,3.8,3.9]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to Mindsdb
+
+Being part of the core MindsDB team is accessible to anyone who is motivated and wants to be part of that journey!
+
+Please see below how to contribute to the project, also refer to the contributing documentation.
+
+## How can you help us?
+
+* Report a bug
+* Improve documentation
+* Discuss the code implementation
+* Submit a bug fix
+* Propose new features
+* Test Mindsdb
+
+## Code contributions
+
+In general, we follow the "fork-and-pull" Git workflow.
+1. Fork the `type_infer` repository
+2. Clone the repository
+3. Make changes and commit them
+4. Push your local branch to your fork
+5. Submit a Pull request so that we can review your changes
+6. Write a commit message
+7. Make sure that the CI tests are GREEN
+
+> NOTE: Be sure to merge the latest from "upstream" before making a pull request! Also, make the PR to the staging branch.
+
+## Feature and Bug reports
+
+We use GitHub issues to track bugs and features. Report them by opening a [new issue](https://github.com/mindsdb/type_infer/issues/new) and fill out all of the required inputs.
+
+## Code review process
+
+The Pull Request reviews are done on a regular basis. Please, make sure you respond to our feedback/questions.
+
+## Community
+
+If you have additional questions or you want to chat with the MindsDB core team, please join our [Slack community](https://join.slack.com/t/mindsdbcommunity/shared_invite/zt-o8mrmx3l-5ai~5H66s6wlxFfBMVI6wQ) or post at [Github Discussions](https://github.com/mindsdb/type_infer/discussions).
+
+To get updates on MindsDB’s latest announcements, releases, and events, sign up for our [Monthly Community Newsletter](https://mindsdb.com/newsletter/?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo).
+
+Join our mission of democratizing machine learning!
+
+## Contributor Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/type_infer/blob/staging/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+

README.md

@@ -1,2 +1,31 @@
-# type_infer
+# MindsDB Type Infer
+<h1 align="center">
+	<img width="300" src="https://github.com/mindsdb/mindsdb_native/blob/stable/assets/[email protected]?raw=true" alt="MindsDB">
+	<br>
+
+</h1>
+<div align="center">
+	<a href="https://github.com/mindsdb/type_infer/actions/workflows/python-package.yml"><img src="https://github.com/mindsdb/type_infer/actions/workflows/python-package.yml/badge.svg?branch=stable" alt="Type Infer workflow"></a>
+  <a href="https://www.python.org/downloads/" target="_blank"><img src="https://img.shields.io/badge/python-3.8.x|%203.9.x-brightgreen.svg" alt="Python supported"></a>
+  <a href="https://badge.fury.io/py/type-infer"><img src="https://badge.fury.io/py/type-infer.svg" alt="PyPI version" height="18"></a>
+<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/type-infer">  
+    <a href="https://join.slack.com/t/mindsdbcommunity/shared_invite/zt-o8mrmx3l-5ai~5H66s6wlxFfBMVI6wQ" target="_blank"><img src="https://img.shields.io/badge/[email protected]?logo=slack " alt="MindsDB Community"></a>
+	</br>
+
+  <h3 align="center">
+    <a href="https://www.mindsdb.com?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Website</a>
+    <span> | </span>
+    <a href="https://mindsdb.github.io/type_infer/">Docs</a>
+    <span> | </span>
+    <a href="https://join.slack.com/t/mindsdbcommunity/shared_invite/zt-o8mrmx3l-5ai~5H66s6wlxFfBMVI6wQ">Community Slack</a>
+    <span> | </span>
+    <a href="https://github.com/mindsdb/mindsdb/projects">Contribute</a>
+    <span> | </span>
+    <a href="https://mindsdb.com/hacktoberfest">Hacktoberfest</a>
+  </h3>
+
+</div>
 Automated type inference for Machine Learning pipelines.
+
+# Documentation
+<a href="https://mindsdb.github.io/type_infer">Documentation link</a>

docssrc/source/index.rst

@@ -32,7 +32,7 @@ We recommend doing the above inside a newly-created python virtual environment.
 Setting up a dev environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 - Clone the repository
-- Run ``cd type_infer && pip install requirements.txt``
+- Run ``cd type_infer && pip install --editable .``
 - Add it to your python path (e.g. by adding ``export PYTHONPATH='/where/you/cloned/repo':$PYTHONPATH`` as a newline at the end of your ``~/.bashrc`` file)
 - Check that the unit-tests are passing by going into the directory where you cloned and running: ``python -m unittest discover tests``