Up.

.cookiecutterrc

@@ -14,6 +14,7 @@ default_context:
     email: [email protected]
     formatter_quote_style: double
     full_name: Ionel Cristian Mărieș
+    function_name: compute
     github_actions: 'yes'
     github_actions_osx: 'yes'
     github_actions_windows: 'yes'

docs/usage.rst

@@ -2,6 +2,9 @@
 Usage
 =====
 
-To use Nameless in a project::
+To use the project:
 
-	import nameless
+.. code-block:: python
+
+    import nameless
+    nameless.compute(...)

src/nameless/__init__.py

@@ -1,7 +1,7 @@
 __version__ = "0.1.0"
 
-from .core import main
+from .core import compute
 
 __all__ = [
-    "main",
+    "compute",
 ]

src/nameless/_core.c

@@ -1,5 +1,5 @@
 
-char* main(int argc, char *argv[]) {
+char* compute(int argc, char *argv[]) {
     if (argc) {
         int len, i,
             max = 0,

src/nameless/_core_build.py

@@ -5,7 +5,7 @@
 ffi = FFI()
 ffi.cdef(
     """
-    char* main(int argv, char *argv[]);
+    char* compute(int argv, char *argv[]);
     """
 )
 

src/nameless/cli.py

@@ -17,7 +17,7 @@
 
 import argparse
 
-from .core import main
+from .core import compute
 
 parser = argparse.ArgumentParser(description="Command description.")
 parser.add_argument(
@@ -30,5 +30,5 @@
 
 def run(args=None):
     args = parser.parse_args(args=args)
-    print(main(args.names))
+    print(compute(args.names))
     parser.exit(0)

src/nameless/core.py

@@ -2,9 +2,9 @@
 from ._core import lib as _lib
 
 
-def main(args):
+def compute(args):
     args = [_ffi.new("char[]", arg.encode()) for arg in args]
-    result = _lib.main(len(args), _ffi.new("char *[]", args))
+    result = _lib.compute(len(args), _ffi.new("char *[]", args))
     if result == _ffi.NULL:
         return None
     else:

tests/test_core.py

@@ -1,5 +1,5 @@
-from nameless import main
+from nameless import compute
 
 
-def test_main():
-    assert main(["a", "bc", "abc"]) == "abc"
+def test_compute():
+    assert compute(["a", "bc", "abc"]) == "abc"

tox.ini

@@ -62,6 +62,7 @@ install_command =
 deps =
     -r{toxinidir}/docs/requirements.txt
 commands =
+    python setup.py clean --all build_ext --force --inplace
     sphinx-build {posargs:-E} -b doctest docs dist/docs
     sphinx-build {posargs:-E} -b html docs dist/docs
     sphinx-build -b linkcheck docs dist/docs