first empty version

AUTHORS.rst

@@ -3,3 +3,4 @@ Contributors
 ============
 
 * aleksandra-kim <[email protected]>
+* cmutel

CHANGELOG.rst

@@ -4,7 +4,3 @@ Changelog
 
 Version 0.1
 ===========
-
-- Feature A added
-- FIX: nasty bug #1729 fixed
-- add your changes here!

src/akula/skeleton.py → akula/skeleton.py

@@ -4,7 +4,7 @@
 ``[options.entry_points]`` section in ``setup.cfg``::
 
     console_scripts =
-         fibonacci = akula.skeleton:run
+         fibonacci = src.skeleton:run
 
 Then run ``pip install .`` (or ``pip install -e .`` for editable mode)
 which will install the command ``fibonacci`` inside your current environment.
@@ -36,7 +36,7 @@
 # ---- Python API ----
 # The functions defined in this section can be imported by users in their
 # Python scripts/interactive interpreter, e.g. via
-# `from akula.skeleton import fib`,
+# `from src.skeleton import fib`,
 # when using this Python module as a library.
 
 
@@ -76,7 +76,7 @@ def parse_args(args):
     parser.add_argument(
         "--version",
         action="version",
-        version="akula {ver}".format(ver=__version__),
+        version="src {ver}".format(ver=__version__),
     )
     parser.add_argument(dest="n", help="n-th Fibonacci number", type=int, metavar="INT")
     parser.add_argument(
@@ -144,6 +144,6 @@ def run():
     # After installing your project with pip, users can also run your Python
     # modules as scripts via the ``-m`` flag, as defined in PEP 338::
     #
-    #     python -m akula.skeleton 42
+    #     python -m src.skeleton 42
     #
     run()

docs/conf.py

@@ -34,7 +34,7 @@
     from sphinx import apidoc
 
 output_dir = os.path.join(__location__, "api")
-module_dir = os.path.join(__location__, "../src/akula")
+module_dir = os.path.join(__location__, "../src/src")
 try:
     shutil.rmtree(output_dir)
 except FileNotFoundError:
@@ -87,7 +87,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "akula"
+project = "src"
 copyright = "2021, aleksandra-kim"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -229,7 +229,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "akula-doc"
+htmlhelp_basename = "src-doc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -246,7 +246,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("index", "user_guide.tex", "akula Documentation", "aleksandra-kim", "manual")
+    ("index", "user_guide.tex", "src Documentation", "aleksandra-kim", "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

setup.cfg

@@ -6,16 +6,16 @@
 [metadata]
 name = akula
 description = Add a short description here!
-author = aleksandra-kim
+author = aleksandra-kim, cmutel
 author_email = [email protected]
 license = MIT
 license_files = LICENSE.txt
 long_description = file: README.rst
 long_description_content_type = text/x-rst; charset=UTF-8
-url = https://github.com/pyscaffold/pyscaffold/
+url = https://github.com/aleksandra-kim/akula/
 # Add here related links, for example:
 project_urls =
-    Documentation = https://pyscaffold.org/
+    Documentation = https://github.com/aleksandra-kim/akula/
 #    Source = https://github.com/pyscaffold/pyscaffold/
 #    Changelog = https://pyscaffold.org/en/latest/changelog.html
 #    Tracker = https://github.com/pyscaffold/pyscaffold/issues
@@ -38,7 +38,7 @@ zip_safe = False
 packages = find_namespace:
 include_package_data = True
 package_dir =
-    =src
+    =akula
 
 # Require a min/specific Python version (comma-separated conditions)
 # python_requires = >=3.8
@@ -52,13 +52,13 @@ install_requires =
 
 
 [options.packages.find]
-where = src
+where = akula
 exclude =
     tests
 
 [options.extras_require]
 # Add here additional requirements for extra features, to install with:
-# `pip install akula[PDF]` like:
+# `pip install src[PDF]` like:
 # PDF = ReportLab; RXP
 
 # Add here test requirements (semicolon/line-separated)
@@ -70,10 +70,10 @@ testing =
 [options.entry_points]
 # Add here console scripts like:
 # console_scripts =
-#     script_name = akula.module:function
+#     script_name = src.module:function
 # For example:
 # console_scripts =
-#     fibonacci = akula.skeleton:run
+#     fibonacci = src.skeleton:run
 # And any other entry points, for example:
 # pyscaffold.cli =
 #     awesome = pyscaffoldext.awesome.extension:AwesomeExtension

setup.py

@@ -1,5 +1,5 @@
 """
-    Setup file for akula.
+    Setup file for src.
     Use setup.cfg to configure your project.
 
     This file was generated with PyScaffold 4.1.1.

tests/conftest.py

@@ -1,5 +1,5 @@
 """
-    Dummy conftest.py for akula.
+    Dummy conftest.py for src.
 
     If you don't know what this is for, just leave it empty.
     Read more about conftest.py under: