Git Notion
==========
Syncs Github markdown files in your repository to Notion.
This utility is described in the following [blog post](https://www.swiftlane.com/blog/syncing-docs-from-code-repositories-to-notion/).
See example [Notion page](https://www.notion.so/git_feature_notion-195c08d3d14140eb9a35ac00f9a0f078).
## Installation
```
pip install git-feature-notion
```
or for local installation:
```bash
git clone https://github.com/NarekA/git-feature-notion.git
cd git-feature-notion
pip install -e .
```
## Configuring
`NOTION_TOKEN_V2` - Can be found in your [browser cookies](https://www.redgregory.com/notion/2020/6/15/9zuzav95gwzwewdu1dspweqbv481s5) for Notion's website.
`NOTION_ROOT_PAGE` - URL for notion page. Repo docs will be a new page under this page.
`NOTION_IGNORE_REGEX` - Regex for paths to ignore.
`NOTION_SEARCH_BY_REGEX` - Regex for pattern for file search.
These environment variables can be set.
```bash
export NOTION_TOKEN_V2=<YOUR_TOKEN>
export NOTION_ROOT_PAGE="https://www.notion.so/..." # Can be in setup.cfg as well
export NOTION_IGNORE_REGEX="models/.*" # Can be in setup.cfg as well
export NOTION_SEARCH_BY_REGEX="**/*.md" # Can be in setup.cfg as well
```
These parameters can be set in the `setup.cfg` for the repo.
```
[git-feature-notion]
ignore_regex = models/.*
notion_root_page = https://www.notion.so/...
search_by_regex = "**/*.md"
```
## Usage
```bash
# To upload your current directory
git_feature_notion
# To upload another directory
git_feature_notion --path path/to/your/repo
```
## Pushing to PYPI
```bash
bumpversion patch # Look-up bumpversion
rm -rf dist/
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*
```
or
```bash
bumpversion --current-version 0.2.6 major setup.py
```
Raw data
{
"_id": null,
"home_page": "https://github.com/radical-app/git-feature-notion",
"name": "git-feature-notion",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "git_feature_notion",
"author": "NarekA",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8a/ee/f69cdf1621aa17477f0d79ecdb763c47c63ec3d8a16f0601bb6b4c2f4a7b/git_feature_notion-1.0.2.tar.gz",
"platform": null,
"description": "Git Notion\n==========\n\nSyncs Github markdown files in your repository to Notion.\n\nThis utility is described in the following [blog post](https://www.swiftlane.com/blog/syncing-docs-from-code-repositories-to-notion/).\n\nSee example [Notion page](https://www.notion.so/git_feature_notion-195c08d3d14140eb9a35ac00f9a0f078).\n\n## Installation\n```\npip install git-feature-notion\n```\n\nor for local installation:\n\n```bash\ngit clone https://github.com/NarekA/git-feature-notion.git\ncd git-feature-notion\npip install -e .\n```\n\n## Configuring\n\n`NOTION_TOKEN_V2` - Can be found in your [browser cookies](https://www.redgregory.com/notion/2020/6/15/9zuzav95gwzwewdu1dspweqbv481s5) for Notion's website.\n`NOTION_ROOT_PAGE` - URL for notion page. Repo docs will be a new page under this page.\n`NOTION_IGNORE_REGEX` - Regex for paths to ignore.\n`NOTION_SEARCH_BY_REGEX` - Regex for pattern for file search.\n\nThese environment variables can be set.\n```bash\nexport NOTION_TOKEN_V2=<YOUR_TOKEN>\nexport NOTION_ROOT_PAGE=\"https://www.notion.so/...\" # Can be in setup.cfg as well\nexport NOTION_IGNORE_REGEX=\"models/.*\" # Can be in setup.cfg as well\nexport NOTION_SEARCH_BY_REGEX=\"**/*.md\" # Can be in setup.cfg as well\n```\n\nThese parameters can be set in the `setup.cfg` for the repo.\n```\n[git-feature-notion]\nignore_regex = models/.*\nnotion_root_page = https://www.notion.so/...\nsearch_by_regex = \"**/*.md\"\n```\n\n## Usage\n\n```bash\n# To upload your current directory\ngit_feature_notion\n\n# To upload another directory\ngit_feature_notion --path path/to/your/repo\n```\n\n\n## Pushing to PYPI\n\n```bash\nbumpversion patch # Look-up bumpversion\nrm -rf dist/\npython3 setup.py sdist bdist_wheel\npython3 -m twine upload dist/*\n```\n\n\nor \n\n```bash\nbumpversion --current-version 0.2.6 major setup.py\n```\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Syncs Github Markdown or any files to Notion",
"version": "1.0.2",
"split_keywords": [
"git_feature_notion"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "3fd5f4b13c0821447d687357f63be499",
"sha256": "98acf32738574d2e6228458798cc5cf036fbb292d52882f7b578fef781788c7c"
},
"downloads": -1,
"filename": "git_feature_notion-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fd5f4b13c0821447d687357f63be499",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 6591,
"upload_time": "2022-12-13T21:23:38",
"upload_time_iso_8601": "2022-12-13T21:23:38.636943Z",
"url": "https://files.pythonhosted.org/packages/c9/81/937f36f46816659efc2b2d81fedec29f66c22fcc2cb997740f5b6a4bf785/git_feature_notion-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "276f9baf06fd18b525ae5ac98662ba5e",
"sha256": "6fe07c192436d5f24f293fa021c1ae28ba3e59d56fa7e40fa8a94b4f84a59282"
},
"downloads": -1,
"filename": "git_feature_notion-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "276f9baf06fd18b525ae5ac98662ba5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 4602,
"upload_time": "2022-12-13T21:23:40",
"upload_time_iso_8601": "2022-12-13T21:23:40.732431Z",
"url": "https://files.pythonhosted.org/packages/8a/ee/f69cdf1621aa17477f0d79ecdb763c47c63ec3d8a16f0601bb6b4c2f4a7b/git_feature_notion-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-13 21:23:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "radical-app",
"github_project": "git-feature-notion",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-feature-notion"
}
JSON
