Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FAQ.md #402

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update FAQ.md #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions doc/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,45 +13,45 @@ Table of Contents
Installation and Deployment Issues
----------------------------------

# Can I install OSRFramework in my Windows machine?
# Can I install OSRFramework on my Windows machine?

Yes, you can.
You still need to download [Python 3](https://www.python.org/downloads/release/python-2715/) from the official website.
Make sure that you click on `Add python.exe to the system path`.
Then, check that Python is reachable typing `python.exe --version` in a CMD.
Then, check that Python is reachable by typing `python.exe --version` in a CMD.
The output should look like this:

```
Python 3.7.5
```

If this is not the case and Python is not recognised, you can follow [these steps](https://superuser.com/questions/143119/how-do-i-add-python-to-the-windows-path).
If this is not the case and Python is not recognized, you can follow [these steps](https://superuser.com/questions/143119/how-do-i-add-python-to-the-windows-path).

You can then proceed as follows installing OSRFramework:

```
pip install osrframework
```

After a while, `usufy`, `mailfy` and the rest of the tools will be reachable.
After a while, `usufy`, `mailfy`, and the rest of the tools will be reachable.


# Why there is no support to Python 2?
# Why is there no support for Python 2?

Moving to Python 3 was in our roadmap since the beginning of the development.
Moving to Python 3 has been on our roadmap since the beginning of the development.
It required some important changes from the original source code and since 0.20.0, OSRFramework is only supported in Python 3.6+.

# Why it does not work in Python 3.5 and below?
# Why doesn't it work in Python 3.5 and below?

Python 3 f-strings where introduced in Python 3.6 and they are required.
It is recommened to use them instead of spaghetti code and .format clauses.
Python 3 f-strings were introduced in Python 3.6, and they are required.
It is recommended to use them instead of spaghetti code and .format clauses.
More information about them can be found in [PEP498](https://www.python.org/dev/peps/pep-0498/).

# Why I receive a `command not found` error after installing and calling `usufy`?
# Why do I receive a `command not found` error after installing and calling `usufy`?

This is a known issue in certain GNU/Linux systems such as some Ubuntu versions.
When installed with `--user`, `pip` installs the user entry points in `~/.local/bin/` folder.
This folder is generally in the System Path but in some systems that's not the case.
This is a known issue in certain GNU/Linux systems, such as some Ubuntu versions.
When installed with `--user`, `pip` installs the user entry points in the `~/.local/bin/` folder.
This folder is generally in the System Path, but in some systems, that's not the case.

There are several workarounds to this:

Expand All @@ -76,7 +76,7 @@ General Usage Questions
# What is the difference between `osrf usufy` and `usufy`?

Technically none.
`osrf` is just an entry point that provided an overview of the tools in the framework.
`osrf` is just an entry point that provides an overview of the tools in the framework.
Thus, doing `osrf --help` can be used to list all the available commands.

```
Expand Down Expand Up @@ -107,21 +107,21 @@ ABOUT ARGUMENTS:

-h, --help shows this help and exists.
--license shows the AGPLv3+ license and exists.
--version shows the version of the program and exists.
--version shows the version of the program and exits.

Use 'osrf <command> --help' to learn more about each command. Check
OSRFramework README.md file for further details on the usage of this program
or follow us on Twitter in <http://twitter.com/i3visio>.
or follow us on Twitter at <http://twitter.com/i3visio>.
```

Note that it also shows a `upgrade` subcommand that can be used to try to upgrade the current package.
Note that it also shows an `upgrade` subcommand that can be used to try to upgrade the current package.

# I see some false positives whenever I launch usufy -n my_nick -p all. What can I do to remove the non-working wrappers?

You have two options:

- **Excluding manually with each call**. You can do it by manually appending `-x facebook` or `--exclude facbeook` to exclude the Facebook wrapper.
- **Excluding them using the configuration file**. In the `general.cfg` file you can specify which platforms to exclude on each call. In GNU/Linux systems and MacOS machines the file can be found in `~/.config/OSRFramework`. In Windows systems, in the home folder of the user `<USER_HOME>/OSRFramework`. The file is a text file which can be edited with any text editor. The only lines to change are the last ones so as to set the `exclude_platforms` to any list of space-separated list of wrappers. For instance, if you needed to exclude the Facebook and Instagram platforms you will have to set the `exclude_platforms` by typing `exclude_platforms = facebook instagram`. Remember that lines starting with a `#` are not interpreted and are provided as examples.
- **Excluding manually with each call**. You can do it by manually appending `-x facebook` or `--exclude facebook` to exclude the Facebook wrapper.
- **Excluding them using the configuration file**. In the `general.cfg` file you can specify which platforms to exclude on each call. In GNU/Linux systems and MacOS machines, the file can be found in `~/.config/OSRFramework`. In Windows systems, it is in the home folder of the user `<USER_HOME>/OSRFramework`. The file is a text file which can be edited with any text editor. The only lines to change are the last ones so as to set the `exclude_platforms` to any list of space-separated list of wrappers. For instance, if you needed to exclude the Facebook and Instagram platforms you will have to set the `exclude_platforms` by typing `exclude_platforms = facebook instagram`. Remember that lines starting with a `#` are not interpreted and are provided as examples.

```
…
Expand Down