atria-tools/island
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[DEV] update the project to use pyproject.toml

Browse Source
This commit is contained in:
Edouard DUPIN 2024-01-28 22:20:32 +01:00
parent 9be73c60d1
commit 15a537455c
12 changed files with 327 additions and 361 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -4,6 +4,7 @@
# Setuptools distribution folder.
/dist/
/build/
/.venv/
# Python egg metadata, regenerated from source files by setuptools.
/*.egg-info

0
LICENSE → LICENSE.txt
View File

38
README.rst → README.md
View File

@ -1,32 +1,16 @@
Lutin
=====
`island` is a generic source downloader and syncronizer is a FREE software tool.
`island` is a generic source downloader and synchronizer is a FREE software tool.
It is compatible with basic format of repo-git manifest. This project is created to be easyest to read with simple interface
It is compatible with basic format of repo-git manifest. This project is created to be easiest to read with simple interface
(no internal git usage, but user level git usage) The main point to create the "fork" is the non-support of repo of relativity
in submodule of git (submodule reference with ../xxx.git) This point is really important when you want to have a rellocable
manifest and project with submodule. The simpl eexample is the atria-soft / generic-library / musicdsp that are availlable on
in submodule of git (submodule reference with ../xxx.git) This point is really important when you want to have a relocate
manifest and project with submodule. The simpl example is the atria-soft / generic-library / musicdsp that are available on
github, gitlab, bitbucket and personal server.
.. image:: https://badge.fury.io/py/island.png
:target: https://pypi.python.org/pypi/island
Release (master)
----------------
.. image:: https://travis-ci.org/HeeroYui/island.svg?branch=master
:target: https://travis-ci.org/HeeroYui/island
Developement (dev)
------------------
.. image:: https://travis-ci.org/HeeroYui/island.svg?branch=dev
:target: https://travis-ci.org/HeeroYui/island
![https://badge.fury.io/py/island.png](https://badge.fury.io/py/island.png))
Instructions
------------
@ -78,7 +62,7 @@ Download and synchronize the sources:
island sync
Select all branch availlable in the worktree: (checkout origin/dev in dev branch and track it, do nothing if the branch does not exist)
Select all branch available in the work-tree: (checkout origin/dev in dev branch and track it, do nothing if the branch does not exist)
island checkout dev
@ -86,6 +70,16 @@ Show the status of the workspace
island status
Develop in local (with virtual env):
====================================
Create your development environment:
```bash
source ./develop.env
```
Run the application . ```island --help```
Manual set in production:
=========================

10
bin/island
View File

@ -1,10 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""Inland main interface.
@author Edouard DUPIN
@copyright 2012, Edouard DUPIN, all right reserved
@license MPL v2.0 (see license file)
"""
import island # Noqa: import

14
develop.env Executable file
View File

@ -0,0 +1,14 @@
#!/bin/bash
#use with source ./develop.env
# see: https://setuptools.pypa.io/en/latest/userguide/development_mode.html
set -e
# Create a virtual environment
python -m venv .venv
# Activate the python virtual environment
source .venv/bin/activate
# Install the package in editable mode (dynamic use of files)
pip install --editable .

258
island/__init__.py
View File

@ -1,264 +1,8 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""Inland main().
"""Inland INIT GLOBAL.
@author Edouard DUPIN
@copyright 2012, Edouard DUPIN, all right reserved
@license MPL v2.0 (see license file)
"""
import copy
import fnmatch
import os
import sys
from typing import Union
import death.ArgElement as arg_element
import death.Arguments as arguments
from realog import debug
# Local import
from . import (
actions,
env,
host,
tools,
)
is_init = False
debug.set_display_on_error(" ==========================\n == Some error occurred ==\n ==========================")
def init() -> None:
"""Global initialization of Island."""
global is_init
if is_init is True:
return
# import local island files
list_of_island_files = tools.import_path_local(
os.path.join(tools.get_current_path(__file__), "actions"),
base_name=env.get_system_base_name() + "*.py",
)
actions.init(list_of_island_files)
# import project actions files
list_of_island_files = tools.import_path_local(
env.get_island_root_path(),
2,
[".island", ".git", "archive"],
base_name=env.get_system_base_name() + "*.py",
)
actions.init(list_of_island_files)
is_init = True
# initialize the system ...
init()
debug.verbose("List of actions: " + str(actions.get_list_of_action()))
my_args = arguments.Arguments()
my_args.add_section("option", "Can be set one time in all case")
my_args.add("h", "help", desc="Display this help")
my_args.add(
"v",
"verbose",
list=[
["0", "None"],
["1", "error"],
["2", "warning"],
["3", "info"],
["4", "debug"],
["5", "verbose"],
["6", "extreme_verbose"],
],
desc="display debug level (verbose) default =2",
)
my_args.add("c", "color", desc="Display message in color")
my_args.add("n", "no-fetch-manifest", haveParam=False, desc="Disable the fetch of the manifest")
my_args.add(
"F",
"filter",
haveParam=True,
desc="Filter the action on a list of path or subpath: -f library",
)
my_args.add(
"f",
"folder",
haveParam=False,
desc="Display the folder instead of the git repository name",
)
my_args.add(
"w",
"wait",
haveParam=True,
desc="Wait between 2 access on the server (needed when the server is really slow to remove ssh connection) (default="
+ str(env.get_wait_between_sever_command())
+ ")",
)
my_args.set_stop_at(actions.get_list_of_action())
local_argument = my_args.parse()
def usage() -> None:
"""Display the help of Island."""
color = debug.get_color_set()
# Generic argument displayed :
my_args.display()
print(" Action available")
list_actions = actions.get_list_of_action()
for elem in list_actions:
print(f" {color['green']}{elem}{color['default']}")
print(f" {actions.get_action_help(elem)}")
"""
print(" {color['green']}init{color['default']}")
print(" initialize a 'island' interface with a manifest in a git ")
print(" {color['green']}sync{color['default']}")
print(" Synchronize the current environnement")
print(" {color['green']}status{color['default']}")
print(" Dump the status of the environnement")
"""
print(f" ex: {sys.argv[0]} -c init http://github.com/atria-soft/manifest.git")
print(f" ex: {sys.argv[0]} sync")
exit(0)
def check_boolean(value: Union[bool, str]) -> bool:
"""Check if the value is a real boolean or a boolean string and return the boolean value.
:param value: Value to check.
:return: Equivalent boolean value.
"""
if value == "" or value == "1" or value == "true" or value == "True" or value is True:
return True
return False
def parse_generic_arg(argument: arg_element.ArgElement, active: bool) -> bool:
"""Keep global args that have no dependence with the mode.
:param argument: _description_
:param active: _description_
:return: _description_
"""
debug.extreme_verbose(f"parse arg : {argument.get_option_name()} {argument.get_arg()} active={active}")
if argument.get_option_name() == "help":
if active is False:
usage()
return True
elif argument.get_option_name() == "jobs":
if active is True:
# multiprocess.set_core_number(int(argument.get_arg()))
pass
return True
elif argument.get_option_name() == "wait":
if active is True:
env.set_wait_between_sever_command(int(argument.get_arg()))
return True
elif argument.get_option_name() == "verbose":
if active is True:
debug.set_level(int(argument.get_arg()))
return True
elif argument.get_option_name() == "folder":
if active is True:
env.set_display_folder_instead_of_git_name(True)
return True
elif argument.get_option_name() == "color":
if active is True:
if check_boolean(argument.get_arg()) is True:
debug.enable_color()
else:
debug.disable_color()
return True
elif argument.get_option_name() == "filter":
if active is True:
env.set_filter_command(str(argument.get_arg()))
return True
elif argument.get_option_name() == "no-fetch-manifest":
if active is False:
env.set_fetch_manifest(False)
return True
return False
# open configuration of island:
config_file = env.get_island_path_user_config()
if os.path.isfile(config_file) is True:
sys.path.append(os.path.dirname(config_file))
debug.debug(f"Find basic configuration file: '{config_file}'")
# the file exist, we can open it and get the initial configuration:
configuration_file = __import__(env.get_system_config_name()[:-3])
if "get_exclude_path" in dir(configuration_file):
data = configuration_file.get_exclude_path()
debug.debug(f"get default config 'get_exclude_path' val='{data}'")
env.set_exclude_search_path(data)
if "get_default_color" in dir(configuration_file):
data = configuration_file.get_default_color()
debug.debug(f"get default config 'get_default_color' val='{data}'")
parse_generic_arg(arg_element.ArgElement("color", str(data)), True)
if "get_default_debug_level" in dir(configuration_file):
data = configuration_file.get_default_debug_level()
debug.debug(f"get default config 'get_default_debug_level' val='{data}'")
parse_generic_arg(arg_element.ArgElement("verbose", str(data)), True)
if "get_default_folder" in dir(configuration_file):
data = configuration_file.get_default_folder()
debug.debug(f"get default config 'get_default_folder' val='{data}'")
parse_generic_arg(arg_element.ArgElement("folder", str(data)), True)
if "get_default_wait" in dir(configuration_file):
data = configuration_file.get_default_wait()
debug.debug(f"get default config 'get_default_wait' val='{data}'")
parse_generic_arg(arg_element.ArgElement("wait", str(data)), True)
if "get_default_filter" in dir(configuration_file):
data = configuration_file.get_default_filter()
debug.debug(f"get default config 'get_default_filter' val='{data}'")
parse_generic_arg(arg_element.ArgElement("filter", str(data)), True)
# parse default unique argument:
for argument in local_argument:
parse_generic_arg(argument, True)
# remove all generic arguments:
new_argument_list = []
for argument in local_argument:
if parse_generic_arg(argument, False) is True:
continue
new_argument_list.append(argument)
# now the first argument is: the action:
if len(new_argument_list) == 0:
debug.warning("--------------------------------------")
debug.warning("Missing the action to do ...")
debug.warning("--------------------------------------")
usage()
# TODO : move tin in actions ...
list_actions = actions.get_list_of_action()
action_to_do = new_argument_list[0].get_arg()
new_argument_list = new_argument_list[1:]
if action_to_do not in list_actions:
debug.warning("--------------------------------------")
debug.warning(f"Wrong action type : '{action_to_do}' available list: {list_actions}")
debug.warning("--------------------------------------")
usage()
# todo : Remove this
if action_to_do != "init" and os.path.exists(env.get_island_path()) is False:
debug.error(f"Can not execute a island cmd if we have not initialize a config: '.{env.get_system_base_name()}' in upper 6 parent path")
exit(-1)
ret = actions.execute(action_to_do, my_args.get_last_parsed() + 1)
exit(ret)
# stop all started threads;
# multiprocess.un_init()

262
island/bin_island.py Executable file
View File

@ -0,0 +1,262 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""Inland main().
@author Edouard DUPIN
@copyright 2012, Edouard DUPIN, all right reserved
@license MPL v2.0 (see license file)
"""
import copy
import fnmatch
import os
import sys
from typing import Union
import death.ArgElement as arg_element
import death.Arguments as arguments
from realog import debug
# Local import
from . import (
actions,
env,
host,
tools,
)
is_init = False
debug.set_display_on_error(" ==========================\n == Some error occurred ==\n ==========================")
def init() -> None:
"""Global initialization of Island."""
global is_init
if is_init is True:
return
# import local island files
list_of_island_files = tools.import_path_local(
os.path.join(tools.get_current_path(__file__), "actions"),
base_name=env.get_system_base_name() + "*.py",
)
actions.init(list_of_island_files)
# import project actions files
list_of_island_files = tools.import_path_local(
env.get_island_root_path(),
2,
[".island", ".git", "archive"],
base_name=env.get_system_base_name() + "*.py",
)
actions.init(list_of_island_files)
is_init = True
def usage(my_args) -> None:
"""Display the help of Island."""
color = debug.get_color_set()
# Generic argument displayed :
my_args.display()
print(" Action available")
list_actions = actions.get_list_of_action()
for elem in list_actions:
print(f" {color['green']}{elem}{color['default']}")
print(f" {actions.get_action_help(elem)}")
"""
print(" {color['green']}init{color['default']}")
print(" initialize a 'island' interface with a manifest in a git ")
print(" {color['green']}sync{color['default']}")
print(" Synchronize the current environnement")
print(" {color['green']}status{color['default']}")
print(" Dump the status of the environnement")
"""
print(f" ex: {sys.argv[0]} -c init http://github.com/atria-soft/manifest.git")
print(f" ex: {sys.argv[0]} sync")
exit(0)
def check_boolean(value: Union[bool, str]) -> bool:
"""Check if the value is a real boolean or a boolean string and return the boolean value.
:param value: Value to check.
:return: Equivalent boolean value.
"""
if value == "" or value == "1" or value == "true" or value == "True" or value is True:
return True
return False
def parse_generic_arg(my_args, argument: arg_element.ArgElement, active: bool) -> bool:
"""Keep global args that have no dependence with the mode.
:param argument: _description_
:param active: _description_
:return: _description_
"""
debug.extreme_verbose(f"parse arg : {argument.get_option_name()} {argument.get_arg()} active={active}")
if argument.get_option_name() == "help":
if active is False:
usage(my_args)
return True
elif argument.get_option_name() == "jobs":
if active is True:
# multiprocess.set_core_number(int(argument.get_arg()))
pass
return True
elif argument.get_option_name() == "wait":
if active is True:
env.set_wait_between_sever_command(int(argument.get_arg()))
return True
elif argument.get_option_name() == "verbose":
if active is True:
debug.set_level(int(argument.get_arg()))
return True
elif argument.get_option_name() == "folder":
if active is True:
env.set_display_folder_instead_of_git_name(True)
return True
elif argument.get_option_name() == "color":
if active is True:
if check_boolean(argument.get_arg()) is True:
debug.enable_color()
else:
debug.disable_color()
return True
elif argument.get_option_name() == "filter":
if active is True:
env.set_filter_command(str(argument.get_arg()))
return True
elif argument.get_option_name() == "no-fetch-manifest":
if active is False:
env.set_fetch_manifest(False)
return True
return False
def main():
# initialize the system ...
init()
debug.verbose("List of actions: " + str(actions.get_list_of_action()))
my_args = arguments.Arguments()
my_args.add_section("option", "Can be set one time in all case")
my_args.add("h", "help", desc="Display this help")
my_args.add(
"v",
"verbose",
list=[
["0", "None"],
["1", "error"],
["2", "warning"],
["3", "info"],
["4", "debug"],
["5", "verbose"],
["6", "extreme_verbose"],
],
desc="display debug level (verbose) default =2",
)
my_args.add("c", "color", desc="Display message in color")
my_args.add("n", "no-fetch-manifest", haveParam=False, desc="Disable the fetch of the manifest")
my_args.add(
"F",
"filter",
haveParam=True,
desc="Filter the action on a list of path or subpath: -f library",
)
my_args.add(
"f",
"folder",
haveParam=False,
desc="Display the folder instead of the git repository name",
)
my_args.add(
"w",
"wait",
haveParam=True,
desc="Wait between 2 access on the server (needed when the server is really slow to remove ssh connection) (default="
+ str(env.get_wait_between_sever_command())
+ ")",
)
my_args.set_stop_at(actions.get_list_of_action())
local_argument = my_args.parse()
# open configuration of island:
config_file = env.get_island_path_user_config()
if os.path.isfile(config_file) is True:
sys.path.append(os.path.dirname(config_file))
debug.debug(f"Find basic configuration file: '{config_file}'")
# the file exist, we can open it and get the initial configuration:
configuration_file = __import__(env.get_system_config_name()[:-3])
if "get_exclude_path" in dir(configuration_file):
data = configuration_file.get_exclude_path()
debug.debug(f"get default config 'get_exclude_path' val='{data}'")
env.set_exclude_search_path(data)
if "get_default_color" in dir(configuration_file):
data = configuration_file.get_default_color()
debug.debug(f"get default config 'get_default_color' val='{data}'")
parse_generic_arg(my_args, arg_element.ArgElement("color", str(data)), True)
if "get_default_debug_level" in dir(configuration_file):
data = configuration_file.get_default_debug_level()
debug.debug(f"get default config 'get_default_debug_level' val='{data}'")
parse_generic_arg(my_args, arg_element.ArgElement("verbose", str(data)), True)
if "get_default_folder" in dir(configuration_file):
data = configuration_file.get_default_folder()
debug.debug(f"get default config 'get_default_folder' val='{data}'")
parse_generic_arg(my_args, arg_element.ArgElement("folder", str(data)), True)
if "get_default_wait" in dir(configuration_file):
data = configuration_file.get_default_wait()
debug.debug(f"get default config 'get_default_wait' val='{data}'")
parse_generic_arg(my_args, arg_element.ArgElement("wait", str(data)), True)
if "get_default_filter" in dir(configuration_file):
data = configuration_file.get_default_filter()
debug.debug(f"get default config 'get_default_filter' val='{data}'")
parse_generic_arg(my_args, arg_element.ArgElement("filter", str(data)), True)
# parse default unique argument:
for argument in local_argument:
parse_generic_arg(my_args, argument, True)
# remove all generic arguments:
new_argument_list = []
for argument in local_argument:
if parse_generic_arg(my_args, argument, False) is True:
continue
new_argument_list.append(argument)
# now the first argument is: the action:
if len(new_argument_list) == 0:
debug.warning("--------------------------------------")
debug.warning("Missing the action to do ...")
debug.warning("--------------------------------------")
usage(my_args)
# TODO : move tin in actions ...
list_actions = actions.get_list_of_action()
action_to_do = new_argument_list[0].get_arg()
new_argument_list = new_argument_list[1:]
if action_to_do not in list_actions:
debug.warning("--------------------------------------")
debug.warning(f"Wrong action type : '{action_to_do}' available list: {list_actions}")
debug.warning("--------------------------------------")
usage(my_args)
# todo : Remove this
if action_to_do != "init" and os.path.exists(env.get_island_path()) is False:
debug.error(f"Can not execute a island cmd if we have not initialize a config: '.{env.get_system_base_name()}' in upper 6 parent path")
exit(-1)
ret = actions.execute(action_to_do, my_args.get_last_parsed() + 1)
exit(ret)

1
island/commands.py
View File

@ -17,7 +17,6 @@ import stat
from realog import debug
from . import (
debug,
env,
multiprocess,
)

33
pyproject.toml
View File

@ -1,2 +1,33 @@
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"
[project]
name = "island"
version = "1.1.0"
requires-python = ">=3.7"
dependencies = ["lxml", "realog", "death", "PyYAML"]
description = "island generic source manager (like repo in simple mode)"
readme = "README.md"
authors = [
{name = "Edouard DUPIN", email = "yui.heero@gmail.com" } # Optional
]
license = {text = "MPL-2"}
classifiers = [
"Development Status :: 2 - Pre-Alpha",
"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
"Programming Language :: Python",
"Topic :: Software Development :: Build Tools"
]
keywords = ["source", "manager", "repo", "qisrc", "lutin"]
[project.urls]
"Homepage" = "http://github.com/HeeroYui/island"
"Bug Reports" = "http://github.com/HeeroYui/island/issues"
"Source" = "http://github.com/HeeroYui/island"
[tool.black]
line-length = 150
line-length = 150
[project.scripts]
island = "island.bin_island:main"

0
setup.cfg
View File

69
setup.py
View File

@ -1,69 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# @author Edouard DUPIN
#
# @copyright 2012, Edouard DUPIN, all right reserved
#
# @license MPL v2.0 (see license file)
#
from setuptools import setup
import os
def readme():
with open("README.rst") as f:
return f.read()
def read_version_file():
if not os.path.isfile("version.txt"):
return ""
file = open("version.txt", "r")
data_file = file.read()
file.close()
if len(data_file) > 4 and data_file[-4:] == "-dev":
data_file = data_file[:-4]
return data_file
# https://pypi.python.org/pypi?%3Aaction=list_classifiers
setup(
name="island",
version=read_version_file(),
description="island generic source manager (like repo in simple mode)",
long_description=readme(),
url="http://github.com/HeeroYui/island",
author="Edouard DUPIN",
author_email="yui.heero@gmail.com",
license="MPL-2",
packages=["island", "island/actions"],
classifiers=[
"Development Status :: 2 - Pre-Alpha",
"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
"Programming Language :: Python",
"Topic :: Software Development :: Build Tools",
],
keywords="source manager repo qisrc lutin",
scripts=["bin/island"],
# Does not work on MacOs
# data_file=[
# ('/etc/bash_completion.d', ['bash-autocompletion/lutin']),
# ],
install_requires=[
"lxml",
"realog",
"death",
"PyYAML",
],
include_package_data=True,
)
# To developp: sudo ./setup.py install
# sudo ./setup.py develop
# TO register all in pip: use external tools:
# pip install twine
# # create the archive
# ./setup.py sdist
# twine upload dist/*

2
version.txt
View File

@ -1 +1 @@
1.1.3
1.1.3