Initial commit

6 files changed, 293 insertions, 0 deletions

diff --git a/CODE-OF-CONDUCT.rst b/CODE-OF-CONDUCT.rst
new file mode 100644
index 0000000..cccb576
--- /dev/null
+++ b/CODE-OF-CONDUCT.rst
@@ -0,0 +1,97 @@
+===================================================
+ Code of Conduct for NETCONF for APK Distributions
+===================================================
+
+
+
+Code of Conduct
+===============
+
+This code of conduct outlines expectations for participation in the Adélie
+Sofrware community, as well as steps for reporting unacceptable behavior.  We
+are committed to providing a welcoming and inspiring community for all.
+People violating this code of conduct may be banned from the community.
+
+Our open source community strives to:
+
+* **Be friendly and patient**: Remember: you might not be communicating in
+  someone else's primary spoken or programming language, and others may not
+  have your level of understanding.
+
+* **Be welcoming**: Our community welcomes and supports people of all types
+  and backgrounds.  This includes, but is not limited to members of any race,
+  ethnicity, culture, national origin, color, immigration status, social and
+  economic class, educational level, sex, sexual orientation, gender identity
+  and expression, age, size, family status, political belief, religion, and
+  mental and physical ability.
+
+* **Be respectful**: We are a world-wide community of professionals, and we
+  conduct ourselves professionally.  Disagreement is no excuse for poor
+  behavior and poor manners.  Disrespectful and unacceptable behavior
+  includes, but is not limited to:
+
+  * Violent threats or language.
+
+  * Discriminatory or derogatory jokes and language.
+
+  * Posting gratuitous, sexually explicit or violent material.
+
+  * Posting, or threatening to post, people's personally identifying
+    information ("doxing").
+
+  * Insults, especially those using discriminatory terms or slurs.
+
+  * Behavior that could be perceived as unwanted sexual attention.
+
+  * Advocating for or encouraging any of the above behaviors.
+
+* **Understand disagreements**: Disagreements, both social and technical, are
+  useful learning opportunities.  Seek to understand the other viewpoints and
+  resolve differences constructively.
+
+This code is not exhaustive or complete.  It serves to capture our common
+understanding of a productive, collaborative environment.  We expect the code
+to be followed in spirit as much as in the letter.
+
+
+Reporting Code of Conduct Issues
+================================
+
+We encourage our community to resolve issues on their own whenever possible.
+This builds a broader and deeper understanding and ultimately a healthier
+interaction.  In the event that an issue cannot be resolved locally, please
+feel free to report your concerns by contacting the Community Arbitration
+team.  Your report will be handled in accordance with our issue resolution
+processes.
+
+In your report please include:
+
+* Your contact information.
+
+* Names (real, usernames or pseudonyms) of any individuals involved.  If there
+  are additional witnesses, please include them as well.
+
+* Your account of what occurred, and if you believe the incident is ongoing.
+  If there is a publicly available record (e.g. a mailing list archive or a
+  public chat log), please include a link or attachment.
+
+* Any additional information that may be helpful.
+
+All reports will be reviewed by a multi-person team and will result in a
+response that is deemed necessary and appropriate to the circumstances.  Where
+additional perspectives are needed, the team may seek insight from others with
+relevant expertise or experience.  The confidentiality of the person reporting
+the incident will be kept at all times.  Involved parties are never part of
+the review team.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+If an individual engages in unacceptable behavior, the review team may take any
+action they deem appropriate, including a permanent ban from the community.
+
+
+Colophon
+========
+
+This code of conduct is based on the template established by the TODO Group
+and used by numerous other large communities (e.g., Facebook, Twitter,
+GitHub, and Microsoft).
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..7a5e72e
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,58 @@
+======================================================
+ Contribution Guide for NETCONF for APK Distributions
+======================================================
+:Author:
+  * **A. Wilcox**, documentation writer
+:Copyright:
+  © 2020 Adélie Software in the Public Benefit Inc.  NCSA open source licence.
+
+
+
+Code Style
+==========
+
+All code must comply with PEP 8.
+
+
+
+Tests
+=====
+
+At this time, a feasible way for testing this project is not known.
+
+
+
+Contributing Changes
+====================
+
+This section describes the usual flows of contribution to this repository.
+For a detailed description of how to contribute to Adélie software, review the
+Handbook_.
+
+.. _Handbook: https://help.adelielinux.org/html/devel/
+
+
+GitLab Pull Requests
+````````````````````
+
+#. If you do not already have a GitLab account, you must create one.
+
+#. Create a *fork* of the NETCONF repository.  For more information, consult
+   the GitLab online documentation.
+
+#. Clone your forked repository to your computer.
+
+#. Make your changes.
+
+#. Test your changes to ensure they are correct.
+
+#. Add (or remove) changed files using ``git add`` and ``git rm``.
+
+#. Commit your changes to the tree using the commands ``git commit -S`` and
+   ``git push``.
+
+#. Visit your forked repository in a Web browser.
+
+#. Choose the *Create Pull Request* button.
+
+#. Review your changes to ensure they are correct, and then submit the form.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6f7ee12
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,32 @@
+Copyright (c) 2020 Adélie Software in the Public Benefit, Inc.
+All rights reserved.
+
+Developed by: 		Adélie Software in the Public Benefit, Inc.
+                        https://www.adelielinux.org/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal with the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject
+to the following conditions:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimers.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimers in
+the documentation and/or other materials provided with the distribution.
+
+Neither the names of Adélie Software Inc, nor the names of its
+contributors, may be used to endorse or promote products derived from this
+Software without specific prior written permission.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..8963e16
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,95 @@
+==========================================
+ README for NETCONF for APK Distributions
+==========================================
+:Authors:
+ * **A. Wilcox**, principal author
+ * **Ariadne Conill**, project manager
+:Status:
+ Development
+:Copyright:
+ © 2020 Adélie Software in the Public Benefit, Inc.  NCSA open source license.
+
+
+.. image:: https://img.shields.io/badge/chat-on%20IRC-blue.svg
+   :target: ircs://irc.interlinked.me:6697/#Adelie-Support
+   :alt: Chat with us on IRC: irc.interlinked.me #Adelie-Support
+
+.. image:: https://img.shields.io/badge/license-NCSA-lightgrey.svg
+   :target: LICENSE
+   :alt: Licensed under NCSA license
+
+
+
+Introduction
+============
+
+This repository contains the source code and documentation for NETCONF for APK
+Distributions, a NETCONF server designed for use on Linux distributions that
+use the APK package manager.
+
+
+License
+```````
+See the LICENSE file in the root directory of this repository for license
+information.
+
+
+Changes
+```````
+Any changes to this repository must be reviewed before being pushed to the
+current branch.
+
+
+
+If You Need Help
+================
+
+This repository is primarily for system developers.  If you're looking for
+help installing or using this project, see our Help Centre on the Web (not yet
+available).
+
+.. _`our Help Centre on the Web`: https://help.adelielinux.org/
+
+
+
+Usage Requirements
+==================
+
+* Python
+
+* The Python ``netconf`` module.
+
+
+
+Repository Layout
+=================
+
+``ncserver``: Server code
+`````````````````````````
+The ``ncserver`` directory contains the server code.
+
+``yang-modules``: YANG modules
+``````````````````````````````
+The ``yang-modules`` directory contains the YANG modules that the server
+implements.
+
+
+
+Contributing
+============
+
+See the CONTRIBUTING.rst_ file in the same directory as this README for
+more details on how to contribute to NETCONF for APK Distributions.
+
+.. _CONTRIBUTING.rst: ./CONTRIBUTING.rst
+
+
+
+Reporting Issues
+================
+
+If you have an issue using NETCONF for APK Distributions, you may view our
+BTS_.  You may also `submit an issue`_ directly.
+
+.. _BTS: https://bts.adelielinux.org/buglist.cgi
+.. _`submit an issue`: https://bts.adelielinux.org/enter_bug.cgi
diff --git a/ncserver/__init__.py b/ncserver/__init__.py
new file mode 100644
index 0000000..41ffc41
--- /dev/null
+++ b/ncserver/__init__.py
@@ -0,0 +1,10 @@
+"""
+The main module for the NETCONF for APK Distributions server.
+
+Copyright © 2020 Adélie Software in the Public Benefit, Inc.
+
+Released under the terms of the NCSA license.  See the LICENSE file included
+with this source distribution for more information.
+
+SPDX-License-Identifier: NCSA
+"""
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..959bb53
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+netconf>=2.1.0