From 4bc562c33a8d9b5622cca54c9500efa42344b880 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Tue, 6 Oct 2020 18:31:37 +0200 Subject: [PATCH 01/10] Set theme jekyll-theme-minimal --- _config.yml | 1 + index.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 _config.yml create mode 100644 index.md diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..2f7efbe --- /dev/null +++ b/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000..fcb324f --- /dev/null +++ b/index.md @@ -0,0 +1,37 @@ +## Welcome to GitHub Pages + +You can use the [editor on GitHub](https://github.com/codeaffen/pyhpipam/edit/gh-pages/index.md) to maintain and preview the content for your website in Markdown files. + +Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + +### Markdown + +Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for + +```markdown +Syntax highlighted code block + +# Header 1 +## Header 2 +### Header 3 + +- Bulleted +- List + +1. Numbered +2. List + +**Bold** and _Italic_ and `Code` text + +[Link](url) and ![Image](src) +``` + +For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). + +### Jekyll Themes + +Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/codeaffen/pyhpipam/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file. + +### Support or Contact + +Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out. From 439af34ecbae3c409e4fa871e2b1296c8a4f440e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Tue, 6 Oct 2020 18:32:35 +0200 Subject: [PATCH 02/10] Example github page From 3448c87b72f6e585daba85f1552c7e07ca94bf34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Tue, 6 Oct 2020 18:12:36 +0200 Subject: [PATCH 03/10] Add gh-pages example --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index 2f7efbe..fff4ab9 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1 @@ -theme: jekyll-theme-minimal \ No newline at end of file +theme: jekyll-theme-minimal From 57bf68b57943ff6106b97666ba11618129a78787 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Thu, 8 Oct 2020 19:07:27 +0200 Subject: [PATCH 04/10] ignores --- .gitignore | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0bd48dd --- /dev/null +++ b/.gitignore @@ -0,0 +1,133 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# our ignores +tests +.env From 56a5af3c182240dffec509b85255efee9e44a4b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Thu, 8 Oct 2020 19:13:29 +0200 Subject: [PATCH 05/10] index introduction --- index.md | 45 ++++++++++++--------------------------------- 1 file changed, 12 insertions(+), 33 deletions(-) diff --git a/index.md b/index.md index fcb324f..7dd962d 100644 --- a/index.md +++ b/index.md @@ -1,37 +1,16 @@ -## Welcome to GitHub Pages +# pyhpipam: phpIPAM API bindings for python -You can use the [editor on GitHub](https://github.com/codeaffen/pyhpipam/edit/gh-pages/index.md) to maintain and preview the content for your website in Markdown files. +pyhpipam is intended to be a complete library for speaking with phpIPAM API. -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. +Using `pyhpipam` is as easy as using the UI. -### Markdown - -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for - -```markdown -Syntax highlighted code block - -# Header 1 -## Header 2 -### Header 3 - -- Bulleted -- List - -1. Numbered -2. List - -**Bold** and _Italic_ and `Code` text - -[Link](url) and ![Image](src) ``` - -For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). - -### Jekyll Themes - -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/codeaffen/pyhpipam/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file. - -### Support or Contact - -Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out. +pi = pyhpipam.api( + url='https://ipam.example.com', + app_id='ansible', + username='apiuser', + password='apiP455wd', + ssl_verify=True +) +pi.search_entity(controller='sections') +``` From 6d0111f8f88567349ed1c24feaccfeb8970b1670 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Sat, 10 Oct 2020 17:43:15 +0200 Subject: [PATCH 06/10] fix language tag --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index 7dd962d..0e6ba3e 100644 --- a/index.md +++ b/index.md @@ -4,7 +4,7 @@ pyhpipam is intended to be a complete library for speaking with phpIPAM API. Using `pyhpipam` is as easy as using the UI. -``` +```python pi = pyhpipam.api( url='https://ipam.example.com', app_id='ansible', From a64e57104f4d87e77bcdd41f409ac3ea500d7e8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Sat, 10 Oct 2020 17:51:11 +0200 Subject: [PATCH 07/10] add rtd remote theme --- _config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index fff4ab9..f4ff0fe 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,2 @@ -theme: jekyll-theme-minimal +#theme: jekyll-theme-minimal +remote_theme: carlosperate/jekyll-theme-rtd From 2d8cbb9d33eb2d6781b59ab8b8c68c428b57cbe8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Mon, 12 Oct 2020 10:03:26 +0200 Subject: [PATCH 08/10] fix example method call --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index 0e6ba3e..6a18a5f 100644 --- a/index.md +++ b/index.md @@ -12,5 +12,5 @@ pi = pyhpipam.api( password='apiP455wd', ssl_verify=True ) -pi.search_entity(controller='sections') +pi.get_entity(controller='sections') ``` From be9a38453c60c4aa2a993b9d3ca5a1da81d0e956 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Tue, 13 Oct 2020 00:41:18 +0200 Subject: [PATCH 09/10] adapt docu to new project name --- index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/index.md b/index.md index 6a18a5f..c3099fa 100644 --- a/index.md +++ b/index.md @@ -1,11 +1,11 @@ -# pyhpipam: phpIPAM API bindings for python +# phpypam: phpIPAM API bindings for python -pyhpipam is intended to be a complete library for speaking with phpIPAM API. +phpypam is intended to be a complete library for speaking with phpIPAM API. -Using `pyhpipam` is as easy as using the UI. +Using `phpypam` is as easy as using the UI. ```python -pi = pyhpipam.api( +pi = phpypam.api( url='https://ipam.example.com', app_id='ansible', username='apiuser', From c389f926c8268d7e4512ea5dfdfc67886271cb82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Wed, 6 Jan 2021 12:42:05 +0100 Subject: [PATCH 10/10] prepare redirect --- index.html | 5 +++++ index.md | 16 ---------------- 2 files changed, 5 insertions(+), 16 deletions(-) create mode 100644 index.html delete mode 100644 index.md diff --git a/index.html b/index.html new file mode 100644 index 0000000..3519215 --- /dev/null +++ b/index.html @@ -0,0 +1,5 @@ + + +Redirecting to https://codeaffen.org/projects/phpypam/ + + diff --git a/index.md b/index.md deleted file mode 100644 index c3099fa..0000000 --- a/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# phpypam: phpIPAM API bindings for python - -phpypam is intended to be a complete library for speaking with phpIPAM API. - -Using `phpypam` is as easy as using the UI. - -```python -pi = phpypam.api( - url='https://ipam.example.com', - app_id='ansible', - username='apiuser', - password='apiP455wd', - ssl_verify=True -) -pi.get_entity(controller='sections') -```